2024-10-29 11:00:58 -07:00
# Solana Exporter
## Overview
2020-06-08 08:23:22 -07:00
2024-10-29 11:00:58 -07:00
The Solana Exporter exports basic monitoring data from a Solana node, using the
[Solana RPC API ](https://solana.com/docs/rpc ).
2020-06-08 08:23:22 -07:00
2024-10-29 11:00:58 -07:00
### Example Usage
2020-06-08 08:29:42 -07:00
2024-10-29 11:00:58 -07:00
To use the Solana Exporter, simply run the program with the desired
[command line configuration ](#Command-Line-Arguments ), e.g.,
2021-01-03 15:47:57 -08:00
2024-10-29 11:00:58 -07:00
```shell
2024-10-31 13:35:14 -07:00
solana-exporter \
2024-10-29 11:00:58 -07:00
-nodekey < VALIDATOR_IDENTITY_1 > -nodekey < VALIDATOR_IDENTITY_2 > \
-balance-address < ADDRESS_1 > -balance-address < ADDRESS_2 > \
-comprehensive-slot-tracking \
-monitor-block-sizes
```
2022-08-11 06:46:07 -07:00
2024-11-12 12:17:44 -08:00
2024-10-21 13:16:04 -07:00
## Installation
2024-10-29 11:00:58 -07:00
### Build
2024-10-21 13:16:04 -07:00
2024-10-31 13:35:14 -07:00
Assuming you already have [Go installed ](https://go.dev/doc/install ), the `solana-exporter` can be installed by
2024-10-29 11:00:58 -07:00
cloning this repository and building the binary:
2024-10-21 13:16:04 -07:00
2024-10-29 11:00:58 -07:00
```shell
2024-10-31 13:35:14 -07:00
git clone https://github.com/asymmetric-research/solana-exporter.git
cd solana-exporter
CGO_ENABLED=0 go build ./cmd/solana-exporter
2024-10-21 13:16:04 -07:00
```
2024-10-29 11:00:58 -07:00
## Configuration
### Command Line Arguments
The exporter is configured via the following command line arguments:
2021-01-03 15:47:57 -08:00
2024-10-29 11:00:58 -07:00
| Option | Description | Default |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
| `-balance-address` | Address to monitor SOL balances for, in addition to the identity and vote accounts of the provided nodekeys - can be set multiple times. | N/A |
| `-comprehensive-slot-tracking` | Set this flag to track `solana_leader_slots_by_epoch` for all validators. | `false` |
| `-http-timeout` | HTTP timeout to use, in seconds. | `60` |
| `-light-mode` | Set this flag to enable light-mode. In light mode, only metrics unique to the node being queried are reported (i.e., metrics such as `solana_inflation_rewards` which are visible from any RPC node, are not reported). | `false` |
| `-listen-address` | Prometheus listen address. | `":8080"` |
| `-monitor-block-sizes` | Set this flag to track block sizes (number of transactions) for the configured validators. | `false` |
| `-nodekey` | Solana nodekey (identity account) representing a validator to monitor - can set multiple times. | N/A |
| `-rpc-url` | Solana RPC URL (including protocol and path), e.g., `"http://localhost:8899"` or `"https://api.mainnet-beta.solana.com"` | `"http://localhost:8899"` |
| `-slot-pace` | This is the time (in seconds) between slot-watching metric collections | `1` |
2021-01-03 15:47:57 -08:00
2024-10-29 11:00:58 -07:00
### Notes on Configuration
2024-10-29 12:48:11 -07:00
* `-light-mode` is incompatible with `-nodekey` , `-balance-address` , `-monitor-block-sizes` , and
`-comprehensive-slot-tracking` , as these options control metrics which are not monitored in `-light-mode` .
2024-10-29 11:00:58 -07:00
* ***WARNING***:
* Configuring `-comprehensive-slot-tracking` will lead to potentially thousands of new Prometheus metrics being
created every epoch.
* Configuring `-monitor-block-sizes` with many `-nodekey` 's can potentially strain the node - every block produced
by a configured `-nodekey` is fetched, and a typical block can be as large as 5MB.
2024-10-09 07:01:44 -07:00
2024-10-29 11:00:58 -07:00
## Metrics
### Overview
2024-10-31 13:35:14 -07:00
The table below describes all the metrics collected by the `solana-exporter` :
2024-10-29 11:00:58 -07:00
2024-11-08 05:21:09 -08:00
| Metric | Description | Labels |
|------------------------------------------------|------------------------------------------------------------------------------------------|-------------------------------|
| `solana_validator_active_stake` | Active stake per validator. | `votekey` , `nodekey` |
| `solana_validator_last_vote` | Last voted-on slot per validator. | `votekey` , `nodekey` |
| `solana_validator_root_slot` | Root slot per validator. | `votekey` , `nodekey` |
| `solana_validator_delinquent` | Whether a validator is delinquent. | `votekey` , `nodekey` |
| `solana_account_balance` | Solana account balances. | `address` |
| `solana_node_version` | Node version of solana.* | `version` |
| `solana_node_is_healthy` | Whether the node is healthy.* | N/A |
| `solana_node_num_slots_behind` | The number of slots that the node is behind the latest cluster confirmed slot.* | N/A |
| `solana_node_minimum_ledger_slot` | The lowest slot that the node has information about in its ledger.* | N/A |
| `solana_node_first_available_block` | The slot of the lowest confirmed block that has not been purged from the node's ledger.* | N/A |
| `solana_node_transactions_total` | Total number of transactions processed without error since genesis.* | N/A |
| `solana_node_slot_height` | The current slot number.* | N/A |
| `solana_node_epoch_number` | The current epoch number.* | N/A |
| `solana_node_epoch_first_slot` | Current epoch's first slot \[inclusive\].* | N/A |
| `solana_node_epoch_last_slot` | Current epoch's last slot \[inclusive\].* | N/A |
| `solana_validator_leader_slots_total` | Number of slots processed. | `status` , `nodekey` |
| `solana_validator_leader_slots_by_epoch_total` | Number of slots processed per validator. | `status` , `nodekey` , `epoch` |
| `solana_cluster_slots_by_epoch_total` | Number of slots processed by the cluster. | `status` , `epoch` |
| `solana_validator_inflation_rewards` | Inflation reward earned. | `votekey` , `epoch` |
| `solana_validator_fee_rewards` | Transaction fee rewards earned. | `nodekey` , `epoch` |
| `solana_validator_block_size` | Number of transactions per block. | `nodekey` , `transaction_type` |
| `solana_node_block_height` | The current block height of the node.* | N/A |
2024-10-29 11:00:58 -07:00
***NOTE***: An `*` in the description indicates that the metric **is** tracked in `-light-mode` .
### Labels
The table below describes the various metric labels:
| Label | Description | Options / Example |
|--------------------|-------------------------------------|------------------------------------------------------|
| `nodekey` | Validator identity account address. | e.g, `Certusm1sa411sMpV9FPqU5dXAYhmmhygvxJ23S6hJ24` |
2024-10-31 01:18:47 -07:00
| `votekey` | Validator vote account address. | e.g., `CertusDeBmqN8ZawdkxK5kFGMwBXdudvWHYwtNgNhvLu` |
2024-10-29 11:00:58 -07:00
| `address` | Solana account address. | e.g., `Certusm1sa411sMpV9FPqU5dXAYhmmhygvxJ23S6hJ24` |
| `version` | Solana node version. | e.g., `v1.18.23` |
| `status` | Whether a slot was skipped or valid | `valid` , `skipped` |
| `epoch` | Solana epoch number. | e.g., `663` |
| `transaction_type` | General transaction type. | `vote` , `non_vote` |
