Skip to content

Commit

Permalink
Fix minor errors in metrics documentation
Browse files Browse the repository at this point in the history
- Changed "telemetries" to "telemetry" for correct usage
- Capitalized "Loki" and "Grafana" to reflect proper nouns
- Corrected "docker compose" to "docker-compose"
  • Loading branch information
sergeypanin1994 committed Jan 13, 2025
1 parent 4359656 commit ef8efcb
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,41 @@
## Requirements

1. `forest` node running locally
2. `docker` & `docker compose` must be available in the `$PATH` (alternatively
2. `docker` & `docker-compose` must be available in the `$PATH` (alternatively
`podman` and `podman-compose` can be used)
3. Port `3000` for `grafana` has to be free.
4. Port `3100` for `loki` has to be free.
3. Port `3000` for `Grafana` has to be free.
4. Port `3100` for `Loki` has to be free.

## Run

To run the metrics stack, use the provided Docker compose file to spawn the
`prometheus`, `loki` and `grafana` containers.
To run the metrics stack, use the provided docker-compose file to spawn the
`prometheus`, `Loki` and `Grafana` containers.

```sh
$ sudo docker compose up --build --force-recreate -d
$ sudo docker-compose up --build --force-recreate -d
# or
$ podman-compose up --build --force-recreate -d
```

This will create a `grafana` container which is preloaded with `loki` data
This will create a `Grafana` container which is preloaded with `Loki` data
source and dashboards which render metrics collected by the `prometheus`
container from the `forest` node running locally. The time series database
managed by Prometheus will persist data to volume `monitoring_prometheus_data`.

Once the metrics stack is running, open up the `grafana` webapp to view the
Once the metrics stack is running, open up the `Grafana` webapp to view the
predefined dashboards. Use the default Grafana credentials: `admin`/`admin`.

To receive telemetries via `Loki`, run `forest-daemon` with `--loki`, then go to
`Configuration/Data Sources` on `grafana` webapp, select `Loki`, click on
To receive telemetry via `Loki`, run `forest-daemon` with `--Loki`, then go to
`Configuration/Data Sources` on `Grafana` webapp, select `Loki`, click on
`Explore`, and then you can run queries with `LogQL`. For details of `LogQL`
refer to its [documentation](https://grafana.com/docs/loki/latest/logql /).
refer to its [documentation](https://Grafana.com/docs/Loki/latest/logql /).

## Reload Dashboards

Assuming your user is in `docker` group.

```sh
$ docker compose up --build --force-recreate -d
$ docker-compose up --build --force-recreate -d
# or
$ podman-compose up --build --force-recreate -d
```

0 comments on commit ef8efcb

Please sign in to comment.