logos-messaging/status-metrics
1
0
Fork 0
mirror of https://github.com/logos-messaging/status-metrics.git synced 2026-01-04 07:03:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arseniy Klempner 2025-01-28 15:09:17 -08:00 committed by GitHub
parent ba593ce83f
commit 16702da504
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,15 +4,15 @@ This repository allows running a Dockerized instance of Prometheus and Grafana w
## Usage ## 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: On macOS, this can be done by running the following command:
```bash ```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. 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 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). 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).