Skip to content

Commit

Permalink
more format
Browse files Browse the repository at this point in the history
  • Loading branch information
kaichaosun committed Feb 18, 2025
1 parent 14bb9c0 commit 72f5430
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -20,15 +22,20 @@ make -j10 run ARGS="--datadir=/Users/<your-user>/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.


### Run Status Metrics

3. Start the local prometheus instance and grafana dashboard by running following command in `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).

0 comments on commit 72f5430

Please sign in to comment.