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

Merge pull request #3 from waku-org/improve-readme

Browse Source 
improve readme instructions
This commit is contained in:
kaichao 2025-02-24 23:10:35 +08:00 committed by GitHub
commit 5314c02812
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,6 +4,8 @@ This repository allows running a Dockerized instance of Prometheus and Grafana w
## Usage
### 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:
@ -12,16 +14,28 @@ 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/<your-user>/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.
### Enable Telemetry
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:
### Run Status Metrics
Start the local prometheus instance and grafana dashboard by running following command in `status-metrics`:
```bash
docker-compose up -d
```
### 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).