mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-01-29 07:45:06 +00:00
82 lines
2.1 KiB
Markdown
82 lines
2.1 KiB
Markdown
# Network stats and monitoring
|
|
|
|
> ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. It will be updated for mainnet soon.
|
|
|
|
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
|
|
|
|
Go to [https://pyrmont.eth2.wtf/](https://pyrmont.eth2.wtf/)
|
|
|
|
|
|
#### 1. Click on add node
|
|
|
|
|
|
#### 2. Configure name and client type
|
|
|
|
|
|
#### 3. Copy the command
|
|
Click on `Compile from source` and copy the command at the bottom.
|
|
|
|
|
|
### 5. Build and run your node with metrics enabled
|
|
|
|
From your `nimbus-eth2` repository, run:
|
|
```
|
|
make NIMFLAGS="-d:insecure" nimbus_beacon_node
|
|
```
|
|
|
|
Followed by:
|
|
|
|
```
|
|
./run-pyrmont-beacon-node.sh --metrics
|
|
```
|
|
|
|
### 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.pyrmont.eth2.wtf:8080" --eth2stats.tls=false \
|
|
--beacon.type="nimbus" \
|
|
--beacon.addr="http://localhost:9190" \
|
|
--beacon.metrics-addr="http://localhost:8008/metrics"
|
|
```
|
|
|
|
Your node should now be displayed on [https://pyrmont.eth2.wtf/](https://pyrmont.eth2.wtf/) :)
|
|
|
|
|
|
|
|
|
|
|