solana/watchtower
Surav Shrestha 1fb4d3bd61
docs: fix typo in watchtower/README.md (#33771)
2023-10-19 17:28:04 +02:00
..
src Upgrades Rust to 1.72.0 & nightly-2023-08-25 (#32961) 2023-09-01 07:26:13 +00:00
.gitignore
Cargo.toml chore: workspace inheritance (#29893) 2023-02-23 22:01:54 +08:00
README.md docs: fix typo in watchtower/README.md (#33771) 2023-10-19 17:28:04 +02:00

README.md

The solana-watchtower program is used to monitor the health of a cluster. It periodically polls the cluster over an RPC API to confirm that the transaction count is advancing, new blockhashes are available, and no validators are delinquent. Results are reported as InfluxDB metrics, with an optional push notification on sanity failure.

If you only care about the health of one specific validator, the --validator-identity command-line argument can be used to restrict failure notifications to issues only affecting that validator.

If you do not want duplicate notifications, for example if you have elected to receive notifications by SMS the --no-duplicate-notifications command-line argument will suppress identical failure notifications.

Metrics

watchtower-sanity

On every iteration this data point will be emitted indicating the overall result using a boolean ok field.

watchtower-sanity-failure

On failure this data point contains details about the specific test that failed via the following fields:

  • test: name of the sanity test that failed
  • err: exact sanity failure message