diff --git a/docs/the_nimbus_book/src/SUMMARY.md b/docs/the_nimbus_book/src/SUMMARY.md index ae8d2e696..1808cbc10 100644 --- a/docs/the_nimbus_book/src/SUMMARY.md +++ b/docs/the_nimbus_book/src/SUMMARY.md @@ -11,10 +11,10 @@ - [Useful pre-genesis checks]() # Volume 2 - [Troubleshooting](./troubleshooting.md) -- [Run your node on a Raspberry Pi](./pi-guide.md) +- [Network stats + monitoring](./eth2-stats.md) - [Metrics and pretty pictures](./metrics-pretty-pictures.md) -- [Infura guide](infura-guide.md) -- [eth2stats guide]() +- [Run your node on a Raspberry Pi](./pi-guide.md) +- [Your own Infura endpoint](infura-guide.md) - [Graffiti the blockchain](./graffiti.md) - [Run a local eth1 node]() - [Run just the beacon node]() diff --git a/docs/the_nimbus_book/src/eth2-stats.md b/docs/the_nimbus_book/src/eth2-stats.md new file mode 100644 index 000000000..7257871eb --- /dev/null +++ b/docs/the_nimbus_book/src/eth2-stats.md @@ -0,0 +1,66 @@ +# Network stats and monitoring + +eth2stats is a network monitoring suite for your beacon node + validator client. + +It consists of a [command-line-interface](https://github.com/Alethio/eth2stats-client) (to help you query your node's API), and an [associated website](https://eth2stats.io/medalla-testnet)(which allows you to monitor your node from anywhere). + +In this guide we'll take you through how to get eth2stats running on your local machine, and how to hook your node up to the website. + +## Prerequisites + +Knowledge of both [git](https://www.learnenough.com/git-tutorial/getting_started) and [command line basics](https://www.learnenough.com/command-line-tutorial/basics), and a working [Golang](https://golang.org/dl/) environment. + +## Guide + +### 1. Clone the eth2stats repository + +``` +git clone https://github.com/Alethio/eth2stats-client.git +``` + +### 2. Move into the repository + +``` +cd eth2stats-client +``` + +### 3. Build the executable + +``` +make build +``` + +### 4. Add your node to eth2stats.io + + +#### 1. Click on add node +![](https://i.imgur.com/zPkMahy.png) + +#### 2. Configure name and client type +![](https://i.imgur.com/nA3AVnT.png) + +#### 3. Copy the command +Click on `Compile from source` and copy the command at the bottom. + +![](https://i.imgur.com/ZcqMkOX.png) + +### 5. Run your node with metrics enabled + +From your `nimbus-eth2` repository, run: +``` +make NIMFLAGS="-d:insecure" medalla +``` + +### 6. Run eth2stats + +From your `eth2stats-client` repository, **run the command you copied in step 4.3:** +``` +./eth2stats-client run --eth2stats.node-name="roger" --data.folder ~/.eth2stats/data --eth2stats.addr="grpc.medalla.eth2stats.io:443" --eth2stats.tls=true --beacon.type="nimbus" --beacon.addr="http://localhost:9190" --beacon.metrics-addr="http://localhost:8008/metrics" +``` + +Your node should now be displayed on eth2stats.io :) + + + + +