diff --git a/update-log/v3.0.0.md b/update-log/v3.0.0.md new file mode 100644 index 0000000..92d2ebe --- /dev/null +++ b/update-log/v3.0.0.md @@ -0,0 +1,98 @@ +# Solana Exporter v3.0.0 + +## Key Changes + +The new `solana-exporter` (renamed from `solana_exporter`) contains many new metrics, standardised naming conventions +and more configurability. + +## What's Changed +### Metric Updates +#### New Metrics + +Below is a list of newly added metrics (see the [README](https://github.com/asymmetric-research/solana-exporter/blob/master/README.md) +for metric descriptions): + +* `solana_account_balance` ([@johnstonematt](https://github.com/johnstonematt)) +* `solana_node_is_healthy` ([@GranderStark](https://github.com/GranderStark)) +* `solana_nude_num_slots_behind` ([@GranderStark](https://github.com/GranderStark)) +* `solana_node_minimum_ledger_slot` ([@GranderStark](https://github.com/GranderStark)) +* `solana_node_first_available_block` ([@GranderStark](https://github.com/GranderStark)) +* `solana_cluster_slots_by_epoch_total` ([@johnstonematt](https://github.com/johnstonematt)) +* `solana_validator_fee_rewards` ([@johnstonematt](https://github.com/johnstonematt)) +* `solana_validator_block_size` ([@johnstonematt](https://github.com/johnstonematt)) +* `solana_node_block_height` ([@GranderStark](https://github.com/GranderStark)) + +#### Renamed Metrics + +The table below contains all metrics renamed in `v3.0.0` ([@johnstonematt](https://github.com/johnstonematt)): + +| Old Name | New Name | +|---------------------------------------|------------------------------------------------| +| `solana_validator_activated_stake` | `solana_validator_active_stake` | +| `solana_confirmed_transactions_total` | `solana_node_transactions_total` | +| `solana_confirmed_slot_height` | `solana_node_slot_height` | +| `solana_confirmed_epoch_number` | `solana_node_epoch_number` | +| `solana_confirmed_epoch_first_slot` | `solana_node_epoch_first_slot` | +| `solana_confirmed_epoch_last_slot` | `solana_node_epoch_last_slot` | +| `solana_leader_slots_total` | `solana_validator_leader_slots_total` | +| `solana_leader_slots_by_epoch` | `solana_validator_leader_slots_by_epoch_total` | + +Metrics were renamed to: +* Remove commitment levels from metric names. +* Standardise naming conventions: + * `solana_validator_*`: Validator-specific metrics which are trackable from any RPC node (i.e., active stake). + * `solana_node_*`: Node-specific metrics which are not trackable from other nodes (i.e., node health). + +#### Removed Metrics + +The following metrics were removed ([@johnstonematt](https://github.com/johnstonematt)): +* `solana_active_validators`: This is redundant as it is simply a `count()` on `solana_validator_delinquent`. + +#### Label Updates + +The following labels were renamed ([@johnstonematt](https://github.com/johnstonematt)): + * `pubkey` was renamed to `votekey`, to clearly identity that it refers to the address of a validators vote account. + +### Config Updates +#### New Config Parameters + +Below is a list of newly added config parameters (see the [README](https://github.com/asymmetric-research/solana-exporter/blob/master/README.md) +for parameter descriptions) ([@johnstonematt](https://github.com/johnstonematt)): + + * `-balance-address` + * `-nodekey` + * `-comprehensive-slot-tracking` + * `-monitor-block-sizes` + * `-slot-pace` + * `-light-mode` + * `-http-timeout` + +#### Renamed Config Parameters + +The table below contains all config parameters renamed in `v3.0.0` ([@johnstonematt](https://github.com/johnstonematt)): + +| Old Name | New Name | +|-------------------------------------|-------------------| +| `-rpcURI` | `-rpc-url` | +| `addr` | `-listen-address` | + +#### Removed Config Parameters + +The following metrics were removed ([@johnstonematt](https://github.com/johnstonematt)): + + * `votepubkey`. Configure validator tracking using the `-nodekey` parameter. + +### General Updates + +* The project was renamed from `solana_exporter` to `solana-exporter`, to conform with +[Go naming conventions](https://github.com/unknwon/go-code-convention/blob/main/en-US.md) ([@johnstonematt](https://github.com/johnstonematt)). +* Testing was significantly improved ([@johnstonematt](https://github.com/johnstonematt)). +* [klog](https://github.com/kubernetes/klog) logging was removed and replaced with [zap](https://github.com/uber-go/zap) + ([@johnstonematt](https://github.com/johnstonematt)) +* Easy usage ([@johnstonematt](https://github.com/johnstonematt)): + * The example dashboard was updated. + * An example prometheus config was added, as well as recording rules for tracking skip rate. + +## New Contributors + +* [@GranderStark](https://github.com/GranderStark) made their first contribution.