Skip to content

Commit

Permalink
docs: Link to the doc of $SOLANA_METRICS_CONFIG from monitoring.md (
Browse files Browse the repository at this point in the history
anza-xyz#3846)

docs: Link to the doc of `$SOLANA_METRICS_CONFIG` from monitoring.md

[Why]
When starting a new validator as a beginner, I was not aware of the
existence of the metrics.solana.com service. I heard about it at some
point, I also discovered it was even a requirement for the Solana
Foundation Delegation Program, but I never read about it in the docs. I
did not think of checking inside the "Architecture" section to learn
about the use of metrics.solana.com.

[How]
Because collecting metrics is crucial as an operator, and
metrics.solana.com it a good starting point, add a link to the
documentation of the `$SOLANA_METRICS_CONFIG` variable from the
Operating a Validator > Best Practices > Monitoring section.
  • Loading branch information
dumbbell authored Jan 26, 2025
1 parent 96101c0 commit bcc6b95
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/src/operations/best-practices/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,13 @@ export TELEGRAM_CHAT_ID=<negative chat id number>
Once your environment variables are set, restart `agave-watchtower`. You should see output about your validator.

To test that your Telegram configuration is working properly, you could stop your validator briefly until it is labeled as delinquent. Up to a minute after the validator is delinquent, you should receive a message in the Telegram group from your bot. Start the validator again and verify that you get another message in your Telegram group from the bot. The message should say `all clear`.

## Collecting metrics

It is important to collect metrics: it helps diagnose existing problems and allows to anticipate future ones.

### metrics.solana.com

There are several public dashboards available, one of them is hosted at [metrics.solana.com](https://metrics.solana.com). Reporting to the solana.com public dashboard is even required if you participate in the [Solana Foundation Delegation Program](https://solana.org/delegation-program). Using it is done by simply setting the `$SOLANA_METRICS_CONFIG` variable in your validator's environment (e.g. at the beginning of your `validator.sh` script).

Refer to the [available Solana clusters documentation](../../clusters/available.md) to get the appropriate value of `$SOLANA_METRICS_CONFIG` for your validator.

0 comments on commit bcc6b95

Please sign in to comment.