From 14bb9c058bdbd73e91b9cdfee2c8c2a9c74891e9 Mon Sep 17 00:00:00 2001 From: kaichaosun Date: Tue, 18 Feb 2025 12:52:53 +0800 Subject: [PATCH] improve readme instructions --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bdec369..4692b15 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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 `metrics` flag. +1. 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: @@ -12,16 +12,23 @@ On macOS, this can be done by running the following command: /Applications/Status.app/Contents/MacOS/nim_status_client --metrics ``` +If you want to run from source, run following make command: + +```bash +make -j10 run ARGS="--datadir=/Users//status-desktop/tmp/app-data --metrics" +``` + 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. +1. Once logged in, make sure that **Telemetry** is switched on in the advanced settings of the application, **restart** the app. -Start the local prometheus instance and grafana dashboard by running: + +3. Start the local prometheus instance and grafana dashboard by running following command in `status-metrics`: ```bash docker-compose up -d ``` -You can now access Grafana at `http://localhost:3000`. Login with the default username `admin` and password `admin`. +4. 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).