Skip to content

Commit

Permalink
chore: update readme (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
MattKetmo authored Oct 18, 2023
1 parent 1f0ee5e commit 8005224
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

**Near Validator Watcher** is a Prometheus exporter to help you monitor missed blocks & chunks of your validator.

![Near Validator Watcher Grafana Dashboard (Prometheus Exporter)](assets/near-validator-watcher-grafana-dashboard.jpg)

## ✨ Usage

Example on mainnet using the default RPC endpoint.

![Near Validator Watcher Grafana Dashboard (Prometheus Exporter)](assets/near-validator-watcher-grafana-dashboard.jpg)

### Via compiled binary

Compiled binary can be found on the [Releases page](https://github.com/kilnfi/near-validator-watcher/releases).
Expand Down Expand Up @@ -60,7 +60,7 @@ GLOBAL OPTIONS:
## ❇️ Endpoints

- `/metrics` exposed Prometheus metrics (see next section)
- `/ready` responds OK when at the node is synced
- `/ready` responds OK when the node is synced
- `/live` responds OK as soon as server is up & running correctly


Expand All @@ -84,6 +84,7 @@ Metrics (without prefix) | Description
`validator_blocks_produced` | Current amount of validator produced blocks
`validator_chunks_expected` | Current amount of validator expected chunks
`validator_chunks_produced` | Current amount of validator produced chunks
`validator_rank` | Current rank of validator based on stake
`validator_slashed` | Validators slashed
`validator_stake` | Current amount of validator stake
`version_build` | The Near node version build
Expand Down

0 comments on commit 8005224

Please sign in to comment.