diff --git a/docs/the_nimbus_book/src/developers.md b/docs/the_nimbus_book/src/developers.md index 858fae4ea..6897d81d4 100644 --- a/docs/the_nimbus_book/src/developers.md +++ b/docs/the_nimbus_book/src/developers.md @@ -217,7 +217,7 @@ USE_MULTITAIL="yes" make local-testnet-minimal You’ll get something like this (click for full size): -[![](https://i.imgur.com/Pc99VDO.png)](https://i.imgur.com/Pc99VDO.png) +[![](./img/developers_01.png)](./img/developers_01.png) You can find out more about the beacon node simulation [here](https://our.status.im/nimbus-development-update-03/#beaconsimulation). diff --git a/docs/the_nimbus_book/src/email-notifications.md b/docs/the_nimbus_book/src/email-notifications.md index 1aba10342..0399fbe6d 100644 --- a/docs/the_nimbus_book/src/email-notifications.md +++ b/docs/the_nimbus_book/src/email-notifications.md @@ -8,17 +8,17 @@ You can create an account on [beaconcha.in](https://beaconcha.in/) to set up ema ### 1. Sign up at [beaconcha.in/register](https://beaconcha.in/register) -### 2. Type your validator's public key into the searchbar +### 2. Type your validator's public key into the search bar -![](https://i.imgur.com/jHjkySK.png) +![](./img/email_01.png) ### 3. Click on the bookmark icon -![](https://i.imgur.com/O7zgE0k.png) +![](./img/email_02.png) ### 4. Tick the boxes and select *Add To Watchlist* -![](https://i.imgur.com/7ff4Ta7.png) +![](./img/email_03.png) diff --git a/docs/the_nimbus_book/src/health.md b/docs/the_nimbus_book/src/health.md index 2b98d6a09..6ee0287cf 100644 --- a/docs/the_nimbus_book/src/health.md +++ b/docs/the_nimbus_book/src/health.md @@ -13,7 +13,7 @@ As long as your validator is within the allowed inclusion distance, you will get You can verify your validator's effectiveness on the [beaconcha.in](https://beaconcha.in/) website. -![](https://i.imgur.com/u80Ub2j.png) +![](./img/health.png) Ideally you want to see a value above 95%. diff --git a/docs/the_nimbus_book/src/img/developers_01.png b/docs/the_nimbus_book/src/img/developers_01.png new file mode 100644 index 000000000..0771d1c16 Binary files /dev/null and b/docs/the_nimbus_book/src/img/developers_01.png differ diff --git a/docs/the_nimbus_book/src/img/email_01.png b/docs/the_nimbus_book/src/img/email_01.png new file mode 100644 index 000000000..a2bc8e4fc Binary files /dev/null and b/docs/the_nimbus_book/src/img/email_01.png differ diff --git a/docs/the_nimbus_book/src/img/email_02.png b/docs/the_nimbus_book/src/img/email_02.png new file mode 100644 index 000000000..80d7a67bc Binary files /dev/null and b/docs/the_nimbus_book/src/img/email_02.png differ diff --git a/docs/the_nimbus_book/src/img/email_03.png b/docs/the_nimbus_book/src/img/email_03.png new file mode 100644 index 000000000..b7f91a257 Binary files /dev/null and b/docs/the_nimbus_book/src/img/email_03.png differ diff --git a/docs/the_nimbus_book/src/img/health.png b/docs/the_nimbus_book/src/img/health.png new file mode 100644 index 000000000..46e60293c Binary files /dev/null and b/docs/the_nimbus_book/src/img/health.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_01.png b/docs/the_nimbus_book/src/img/metrics_01.png new file mode 100644 index 000000000..602c9c526 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_01.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_02.png b/docs/the_nimbus_book/src/img/metrics_02.png new file mode 100644 index 000000000..2f11901f0 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_02.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_03.png b/docs/the_nimbus_book/src/img/metrics_03.png new file mode 100644 index 000000000..399214a69 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_03.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_04.png b/docs/the_nimbus_book/src/img/metrics_04.png new file mode 100644 index 000000000..e5187871a Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_04.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_05.png b/docs/the_nimbus_book/src/img/metrics_05.png new file mode 100644 index 000000000..e5514d529 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_05.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_06.png b/docs/the_nimbus_book/src/img/metrics_06.png new file mode 100644 index 000000000..b66e03d43 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_06.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_07.png b/docs/the_nimbus_book/src/img/metrics_07.png new file mode 100644 index 000000000..8a2828384 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_07.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_08.png b/docs/the_nimbus_book/src/img/metrics_08.png new file mode 100644 index 000000000..9e3640032 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_08.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_09.png b/docs/the_nimbus_book/src/img/metrics_09.png new file mode 100644 index 000000000..d738c22da Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_09.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_10.png b/docs/the_nimbus_book/src/img/metrics_10.png new file mode 100644 index 000000000..60b1f59df Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_10.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_11.png b/docs/the_nimbus_book/src/img/metrics_11.png new file mode 100644 index 000000000..fc90a96f6 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_11.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_12.png b/docs/the_nimbus_book/src/img/metrics_12.png new file mode 100644 index 000000000..f3d209fb7 Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_12.png differ diff --git a/docs/the_nimbus_book/src/img/metrics_13.png b/docs/the_nimbus_book/src/img/metrics_13.png new file mode 100644 index 000000000..ab4e7b3ba Binary files /dev/null and b/docs/the_nimbus_book/src/img/metrics_13.png differ diff --git a/docs/the_nimbus_book/src/metrics-pretty-pictures.md b/docs/the_nimbus_book/src/metrics-pretty-pictures.md index b72673517..609586ad3 100644 --- a/docs/the_nimbus_book/src/metrics-pretty-pictures.md +++ b/docs/the_nimbus_book/src/metrics-pretty-pictures.md @@ -124,7 +124,7 @@ Follow [the instructions for your platform](https://grafana.com/docs/grafana/lat Go to [http://localhost:3000/](http://localhost:3000/), you should see a Grafana login screen that looks like this: -![](https://i.imgur.com/jcP1qWl.png) +![](./img/metrics_01.png) Type in `admin` for both the username and password. You'll be asked to change the password (and we recommend you do so). @@ -134,48 +134,48 @@ You'll be asked to change the password (and we recommend you do so). Hover your mouse over the gear icon in the left menu bar, and click on the `Data Sources` option in the sub-menu that pops up. -![](https://i.imgur.com/0Xsgx61.png) +![](./img/metrics_02.png) Now click on the `Add Data Source` button in the center of the screen -![](https://i.imgur.com/YRVJjdD.png) +![](./img/metrics_03.png) Select `Prometheus` -![](https://i.imgur.com/YpwThOr.png) +![](./img/metrics_04.png) Enter `http://localhost:9090` in the URL field -![](https://i.imgur.com/PtVOnur.png) +![](./img/metrics_05.png) Set the "Scrape interval" field to the same value you used in the Prometheus config ("15s" in our example below). Scroll to the bottom and click on `Save and Test` -![](https://i.imgur.com/GJVdwaK.png) +![](./img/metrics_06.png) If everything is working correctly you should see a green `Data source is working` box pop up -![](https://i.imgur.com/vf5ahNA.png) +![](./img/metrics_07.png) #### 8. Import a dashboard Now, let's import a dashboard; hover your mouse over the `+` icon in the left menu bar and select `import` from the pop-up menu -![](https://i.imgur.com/WnnAcUR.png) +![](./img/metrics_08.png) Click on `Upload JSON file` -![](https://i.imgur.com/l65ICZ2.png) +![](./img/metrics_09.png) Select the `beacon_nodes_Grafana_dashboard.json` from the `nimbus-eth2/grafana/` folder and click on `Import` -![](https://i.imgur.com/SoU5Isz.png) +![](./img/metrics_10.png) You'll be directed to the dashboard where you'll be able to gain insights into the performance of `nimbus-eth2` and your validators -![](https://i.imgur.com/aIfJ1iT.png) +![](./img/metrics_11.png) !!! note The dashboard is very much a work in progress. @@ -190,7 +190,7 @@ And voilà! That's all there is to it :) ### Joe Clapis -![](https://i.imgur.com/05eJeBr.png) +![](./img/metrics_12.png) Joe — who’s done some brilliant work [integrating Nimbus with Rocket Pool](https://our.status.im/rocket-pool-integration/) — has created a [wonderful guide](https://github.com/jclapis/rp-pi-guide/blob/main/Grafana.md) where he takes you through how to set up a Grafana server on your Pi, using his dashboard as an example. @@ -203,7 +203,7 @@ Whether or not you're running a Pi, we recommend you check out [his guide]( http ### Metanull -![](https://i.imgur.com/OlvNGlq.jpg) +![](./img/metrics_13.png) A dashboard aimed primarily at users rather than developers. diff --git a/grafana/README.md b/grafana/README.md index 1f97782f3..884abde88 100644 --- a/grafana/README.md +++ b/grafana/README.md @@ -19,10 +19,10 @@ In order to use it locally, you would have to make some changes: Click the small "share" icon on the top-left of the Grafana dashboard: -![share icon](https://i.imgur.com/ds3BJoj.png) +![share icon](./img/grafana_01.png) Go to the "Export" tab and enable "Export for sharing externally": -![export tab](https://i.imgur.com/sxgrThb.png) +![export tab](./img/grafana_02.png) Now you can either "Save to file" or "View JSON" and copy/paste into the destination file, whichever is faster for you. diff --git a/grafana/img/grafana_01.png b/grafana/img/grafana_01.png new file mode 100644 index 000000000..b81997f4c Binary files /dev/null and b/grafana/img/grafana_01.png differ diff --git a/grafana/img/grafana_02.png b/grafana/img/grafana_02.png new file mode 100644 index 000000000..ee1deed6f Binary files /dev/null and b/grafana/img/grafana_02.png differ