Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update obol-monitoring.md with instructions for Dappnode #419

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions versioned_docs/version-v1.1.1/advanced/obol-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

<Tabs groupId="Monitoring">
<TabItem value="CLI" label="CLI">

The provided credentials needs to be added in `prometheus/prometheus.yml` replacing `$PROM_REMOTE_WRITE_TOKEN` and will look like:

```shell
Expand Down Expand Up @@ -53,3 +59,57 @@ After updating and saving the `prometheus/prometheus.yml`, you must restart the
```shell
docker compose restart prometheus
```
</TabItem>
<TabItem value="Dappnode" label="Dappnode">
#### 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 <a href="[http://my.dappnode/installer/dnp/obol.dnp.dappnode.eth](http://dms.dappnode/)" target="_blank">http://dms.dappnode/</a>

<p>
<ol>
<li>
Login to the DappNode Interface:{" "}
<a href="http://my.dappnode/dashboard" target="_blank">
Dappnode Login
</a>
<img src="/img/dappnodeLogin.png" alt="Dappnode Login" />
</li>
<li>
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.
</li>
<li>
Once the package is installed, it should reflect on your 'Packages'
</li>
</ol>
</p>

#### Adding montitoring credentials to Obol config

With DMS installed, the below steps will walk through adding the monitoring credential provided by [email protected] or your squad leader.

<p>
<ol>
<li>
Click 'Packages' > 'Obol' > 'Config'
</li>
<li>
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.
</li>
<li>
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.
</li>
<li>
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.
</li>
<li>
Navigate to the bottom of the page and click 'Update'
</li>
</ol>
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add restart package to begin pushing metrics.

</p>
</TabItem>
</Tabs>