Skip to content

Commit

Permalink
chore: update readme (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
vgorkavenko committed Apr 4, 2023
1 parent 8acff77 commit d61c047
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 1 deletion.
Binary file added .images/nodeoperators-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .images/rewards-penalties-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .images/validators-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ethereum-validators-monitoring (aka balval)
# 🐢 ethereum-validators-monitoring (aka balval)

Consensus layer validators monitoring bot, that fetches Lido or Custom Users Node Operators keys
from Execution layer and checks their performance in Consensus
Expand All @@ -9,6 +9,37 @@ writes data to **Clickhouse**, displays aggregates by **Grafana**
dashboard, alerts about bad performance by **Prometheus + Alertmanger** and
routes notifications to Discord channel via **alertmanager-discord**.

## Dashboards

There are three dashboards in Grafana:
* **Validators** - shows aggregated data about performance for all monitored validators
![Validators](.images/validators-dashboard.png)
* **NodeOperator** - shows aggregated data about performance for each monitored node operator
![NodeOperators](.images/nodeoperators-dashboard.png)
* **Rewards & Penalties** - shows aggregated data about rewards, penalties, and missed rewards for each monitored node operator
![Rewards & Penalties](.images/rewards-penalties-dashboard.png)

## Alerts

There are several default alerts which are triggered by Prometheus rules:

* General:
* 🔪 Slashed validators
* 💸 Operators with negative balance delta
* Proposals:
* 📥 Operators with missed block propose
* 📈📥 Operators with missed block propose (on possible high reward validators)
* Sync:
* 🔄 Operators with bad sync participation
* 📈🔄 Operators with bad sync participation (on possible high reward validators)
* Attestations:
* 📝❌ Operators with missed attestation
* 📝🐢 Operators with high inc. delay attestation
* 📝🏷️ Operators with two invalid attestation property (head/target/source)
* 📈📝❌ Operators with missed attestation (on possible high reward validators)



## First run

You have two options to run this application: `docker-compose` or `node`
Expand Down

0 comments on commit d61c047

Please sign in to comment.