From 616a8ecaa6e5334be70e6e4c11173d828beaf611 Mon Sep 17 00:00:00 2001 From: Chris <152811424+chris24eth@users.noreply.github.com> Date: Sat, 28 Sep 2024 07:16:44 -0400 Subject: [PATCH] Update obol-monitoring.md with instructions for Dappnode Added instructions for adding monitoring for DappNode users. --- .../advanced/obol-monitoring.md | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/versioned_docs/version-v1.1.1/advanced/obol-monitoring.md b/versioned_docs/version-v1.1.1/advanced/obol-monitoring.md index 27c6f65e87..b4b212a8e6 100644 --- a/versioned_docs/version-v1.1.1/advanced/obol-monitoring.md +++ b/versioned_docs/version-v1.1.1/advanced/obol-monitoring.md @@ -3,6 +3,9 @@ sidebar_position: 3 description: Add monitoring credentials to help the Obol Team monitor the health of your cluster --- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + # Push Metrics to Obol Monitoring :::info @@ -11,6 +14,9 @@ This is **optional** and does not confer any special privileges within the Obol You may have been provided with **Monitoring Credentials** used to push distributed validator metrics to Obol's central Prometheus cluster to monitor, analyze, and improve your Distributed Validator Cluster's performance. + + + The provided credentials needs to be added in `prometheus/prometheus.yml` replacing `$PROM_REMOTE_WRITE_TOKEN` and will look like: ```shell @@ -53,3 +59,57 @@ After updating and saving the `prometheus/prometheus.yml`, you must restart the ```shell docker compose restart prometheus ``` + + +#### Install Dappnode Monitoring Service (DMS) + +Before preparing the DappNode to take part in performance monitoring, you must ensure you have the Dappnode Monitoring Software (DMS) package installed and you will need the monitoring credential sent to you by Obol or shared by your Squad leader. + +#### Installing and accessing DMS + +Locate DMS in your DAppStore, listed among the Featured packages. The installation process is straightforward, much like any other Dappnode package. After installation, you can access DMS Grafana and explore all its dashboards by visiting http://dms.dappnode/ + +

+

    +
  1. + Login to the DappNode Interface:{" "} + + Dappnode Login + + Dappnode Login +
  2. +
  3. + Click on the 'DAppStore' tab on the left side, locate and install DMS among the Featured packages. After installation, you can access DMS Grafana and explore all its dashboards by visiting http://dms.dappnode. +
  4. +
  5. + Once the package is installed, it should reflect on your 'Packages' +
  6. +
+

+ +#### Adding montitoring credentials to Obol config + +With DMS installed, the below steps will walk through adding the monitoring credential provided by techne@obol.tech or your squad leader. + +

+

    +
  1. + Click 'Packages' > 'Obol' > 'Config' +
  2. +
  3. + Locate the field 'Charons to monitor by Obol (optional)' and input the Charon number which is to be monitored by Obol team for performance and reliability. +
  4. +
  5. + Locate Prometheus Monitoring URL field, it should populate with 'https://vm.monitoring.gcp.obol.tech/write' if not, add that now. This is the URL to send the monitoring metrics to. The server must be able to receive the metrics from the prometheus service. +
  6. +
  7. + Locate the field called 'Prometheus Monitoring Credentials' This is where you will input the monitoring credential provided to you by Obol or shared by your squad leader. +
  8. +
  9. + Navigate to the bottom of the page and click 'Update' +
  10. +
+

+
+
+