From 16702da50487fc9daeedbe5ce9ade0e7b1d5f6d6 Mon Sep 17 00:00:00 2001 From: Arseniy Klempner Date: Tue, 28 Jan 2025 15:09:17 -0800 Subject: [PATCH] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 60d9605..bdec369 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ This repository allows running a Dockerized instance of Prometheus and Grafana w ## Usage -This has been tested against `status-desktop`. To enable the Waku metrics port, you must run the application with the `waku-metrics` flag. +This has been tested against `status-desktop`. To enable the Waku metrics port, you must run the application with the `metrics` flag. On macOS, this can be done by running the following command: ```bash -/Applications/Status.app/Contents/MacOS/nim_status_client --waku-metrics +/Applications/Status.app/Contents/MacOS/nim_status_client --metrics ``` -By default, it uses port `9305`. You can set the port using `--waku-metrics-port 9305`. Make sure the same port is set in [`prometheus/prometheus.yml`](prometheus/prometheus.yml). +By default, it uses host and port `0.0.0.0:9305`. You can set the port using `--metrics-address 0.0.0.0:9305`. Make sure the same port is set in [`prometheus/prometheus.yml`](prometheus/prometheus.yml). Once logged in, make sure that Telemetry is switched on in the advanced settings of the application. @@ -22,6 +22,6 @@ Start the local prometheus instance and grafana dashboard by running: docker-compose up -d ``` -You can now access Grafana at `http://localhost:3000`. Login with the default username `admin`and password `admin`. +You can now access Grafana at `http://localhost:3000`. Login with the default username `admin` and password `admin`. An existing dashboard is available at `http://localhost:3000/d/status-go-metrics/status-go-metrics?orgId=1&from=now-5m&to=now&refresh=5s`. Any changes to the dashboard can be saved by copying the dashboard JSON and overwriting the file in [`grafana/provisioning/dashboards/status-go.json`](grafana/provisioning/dashboards/status-go.json).