Configuration

After running solana-exporter generate, a template config file will be created in either the specified location or the default directory (~/.solana-exporter). This page explains the individual variables and how they affect the exporter.

Sample configuration

rpc = 'http://localhost:8899'
target = '0.0.0.0:9179'
vote_account_whitelist = []
staking_account_whitelist = []

[maxmind]
username = 'username'
password = 'password'
  • rpc - the location of the JSON-RPC node. This can be a local RPC node, or a public one.
    • Remark: Public nodes usually have a rate-limiting policy in place that makes usage with solana-exporter difficult (e.g., delayed response times).
  • target - the target address/port to export Prometheus gauges to.
  • vote_account_whitelist - an array that instructs the exporter to only export statistics related to the specified vote pubkeys, and their corresponding node pubkeys if found.
  • staking_account_whitelist - an array that instructs the exporter to only export APY statistics related to the specified staking pubkeys.
  • [maxmind] - The exporter can optionally use MaxMind's GeoIP2 Precision City Service to export decentralisation-related metrics. However, this requires you to sign up for a MaxMind account and regularly top-up your account with credits.
    • username - the username of the API key.
    • password - the password of the API key.

Important note on vote_account_whitelist and staking_account_whitelist

As explained above, whitelists can be used to restrict the amount APY statistics exported. However, care should be taken if you modify the whitelists and then reload solana-exporter. In particular, for the following gauges:

  • solana_current_staking_apy
  • solana_average_staking_apy

if any newly-appearing (e.g., formerly excluded) pubkeys were not fetched for a particular epoch, then solana-exporter will not attempt to "back-fill" data for either the current or past epochs. Therefore, those pubkeys will be missing from the gauges until the next epoch begins. This is due to the fact that the exporter only scrapes the ledger for rewards data once at the beginning of every epoch.

To force a re-fresh of the current epoch's rewards, delete the database.

Overriding the config file location

  • Standalone program: The default location is ~/.solana-exporter/config.toml. Override this with the -c flag.
  • Docker container: Change the bind-mount location.

Overriding the database location

To speed up processing and reduce unnecessary network traffic, solana-exporter uses a persistent database to cache some requests.

  • Standalone program: The default location is ~/.solana-exporter/persistent.db. Override this with the -d flag.
  • Docker container: The location cannot be overridden; the exporter expects a database to be mounted in /exporter/.