diff --git a/README.md b/README.md index 4692b15..26b151b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This repository allows running a Dockerized instance of Prometheus and Grafana w ## Usage -1. This has been tested against `status-desktop`. To enable the Waku metrics port, you must run the application with the `metrics` flag. +### Run Status Desktop + +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: @@ -20,15 +22,20 @@ make -j10 run ARGS="--datadir=/Users//status-desktop/tmp/app-data --m 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). -1. Once logged in, make sure that **Telemetry** is switched on in the advanced settings of the application, **restart** the app. +### Enable Telemetry +Once logged in, make sure that **Telemetry** is switched on in the advanced settings of the application, **restart** the app. -3. Start the local prometheus instance and grafana dashboard by running following command in `status-metrics`: +### Run Status Metrics + +Start the local prometheus instance and grafana dashboard by running following command in `status-metrics`: ```bash docker-compose up -d ``` -4. You can now access Grafana at `http://localhost:3000`. Login with the default username `admin` and password `admin`. +### Access Grafana + +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).