Update README
This commit is contained in:
parent
0ea2843ec9
commit
da17783242
|
@ -1,8 +1,8 @@
|
||||||
The `solana-watchtower` program is used to monitor the health of a cluster. It
|
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
|
periodically polls the cluster over an RPC API to confirm that the transaction
|
||||||
count is advancing, new blockhashes are available, and no validators are
|
count is advancing, new blockhashes are available, and no validators are
|
||||||
delinquent. Results are reported as InfluxDB metrics, with an optional
|
delinquent. Results are reported as InfluxDB metrics, with an optional push
|
||||||
Slack/Discord push notification on sanity failure.
|
notification on sanity failure.
|
||||||
|
|
||||||
If you only care about the health of one specific validator, the
|
If you only care about the health of one specific validator, the
|
||||||
`--validator-identity` command-line argument can be used to restrict failure
|
`--validator-identity` command-line argument can be used to restrict failure
|
||||||
|
@ -21,14 +21,14 @@ the following fields:
|
||||||
|
|
||||||
|
|
||||||
### Sanity failure push notification
|
### Sanity failure push notification
|
||||||
To receive a Slack, Discord and/or Telgram notification on sanity failure,
|
To receive a Slack, Discord and/or Telegram notification on sanity failure,
|
||||||
define environment variables before running `solana-watchtower`:
|
define environment variables before running `solana-watchtower`:
|
||||||
```
|
```
|
||||||
export SLACK_WEBHOOK=...
|
export SLACK_WEBHOOK=...
|
||||||
export DISCORD_WEBHOOK=...
|
export DISCORD_WEBHOOK=...
|
||||||
```
|
```
|
||||||
|
|
||||||
Telgram requires the following two variables:
|
Telegram requires the following two variables:
|
||||||
```
|
```
|
||||||
export TELEGRAM_BOT_TOKEN=...
|
export TELEGRAM_BOT_TOKEN=...
|
||||||
export TELEGRAM_CHAT_ID=...
|
export TELEGRAM_CHAT_ID=...
|
||||||
|
|
Loading…
Reference in New Issue