status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-01-11 06:46:10 +00:00
Code Issues Projects Releases Wiki Activity

Reinstate + update grafana tutorial (#2111)

Browse Source
This commit is contained in:
Sacha Saint-Leger 2020-11-30 15:15:09 +01:00 committed by GitHub
parent 48646af5b5
commit fff8ffd2d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/the_nimbus_book/src/SUMMARY.md
View File

@ -15,6 +15,7 @@
- [Command line options](./options.md)
- [Troubleshooting](./troubleshooting.md)
- [Nimbus binaries](./binaries.md)
- [Grafana and Prometheus](metrics-pretty-pictures.md)
- [Network stats + monitoring](./eth2-stats.md)
- [Run your node on a Raspberry Pi](./pi-guide.md)
- [Raspberry Pi: Mainnet advice](./pi-guide-mainnet.md)

36
docs/the_nimbus_book/src/metrics-pretty-pictures.md
View File

@ -1,6 +1,4 @@
# Metrics and pretty pictures
> ⚠️ This page concerns the Pyrmont testnet. If you have made a mainnet deposit, you do not need to connect to eth2 quite yet. Mainnet [Genesis](https://hackmd.io/@benjaminion/genesis) date has been set to [December 1st](https://blog.ethereum.org/2020/11/04/eth2-quick-update-no-19/). This page will be updated nearer the time.
# Grafana and Prometheus
In this page we'll cover how to use Grafana and Prometheus to help you visualise important real-time metrics concerning your validator and/or beacon node.
@ -10,7 +8,7 @@ Grafana is a tool for beautiful dashboard monitoring that works well with Promet
## Simple metrics
The easiest way to see metrics concerning your validator / node is to build the beacon node with the `NIMFLAGS="-d:insecure"` flag. For example, to enable metrics for a `medalla` validator, run:
The easiest way to see metrics concerning your validator / node is to build the beacon node with the `NIMFLAGS="-d:insecure"`:
```
make NIMFLAGS="-d:insecure" nimbus_beacon_node
@ -73,12 +71,26 @@ cp prometheus-2.20.1.linux-amd64/prometheus /usr/local/bin/
Prometheus relies on a YAML configuration file to let it know where, and how often, to scrape data.
`nimbus-eth2` generates an appropriate configuration file (`prometheseus.yml`) when you build the beacon node. If you're running the `medalla` testnet you'll find this in `build/data/medalla`.
To run Prometheus with the default config file:
Example config file:
```
global:
scrape_interval: 1s
scrape_configs:
- job_name: "nimbus"
static_configs:
- targets: ['127.0.0.1:8008']
labels:
node: '0'
```
Save the above as `prometheus.yml` in the `nimbus-eth2` repo.
Then run Prometheus:
```
cd build/data/medalla
prometheus --config.file=./prometheus.yml --storage.tsdb.path=./prometheus
# when starting multiple nodes at the same time, just use the config file from the one with the highest ID
```
@ -160,11 +172,3 @@ And voila! That's all there is to it :)
TODO
### Discord
TODO
## Additional resources
- [Guide to Staking on Ethereum 2.0 (Ubuntu/Medalla/Nimbus)](https://medium.com/@SomerEsat/guide-to-staking-on-ethereum-2-0-ubuntu-medalla-nimbus-5f4b2b0f2d7c): a guide by an outside contributer that contains some very informative sections on both Prometheus and Grafana. We strongly recommend reading through the relevant sections if you're using a linux device and/or using `systemd`.
- [Our dashboard](https://metrics.status.im/d/pgeNfj2Wz23/nimbus-testnet3?orgId=1&from=now-6h&to=now&var-container=beacon-node-testnet3&var-instance=node-03.aws-eu-central-1a.nimbus.test) (AWS Medalla nodes)