mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-20 11:45:53 +00:00
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# Example of clio monitoring infrastructure
|
|
|
|
> [!WARNING]
|
|
> This is only an example of Grafana dashboard for Clio. It was created for demonstration purposes only and may contain errors.
|
|
> Clio team would not recommend to relate on data from this dashboard or use it for monitoring your Clio instances.
|
|
|
|
This directory contains an example of docker based infrastructure to collect and visualize metrics from clio.
|
|
|
|
The structure of the directory:
|
|
|
|
- `compose.yaml`
|
|
Docker Compose file with Prometheus and Grafana set up.
|
|
- `prometheus.yaml`
|
|
Defines metrics collection from Clio and Prometheus itself.
|
|
Demonstrates how to setup Clio target and Clio's admin authorization in Prometheus.
|
|
- `grafana/clio_dashboard.json`
|
|
Json file containing pre-configured dashboard in Grafana format.
|
|
- `grafana/dashboard_local.yaml`
|
|
Grafana configuration file defining the directory to search for dashboards json files.
|
|
- `grafana/datasources.yaml`
|
|
Grafana configuration file defining Prometheus as a data source for Grafana.
|
|
|
|
## How to try
|
|
|
|
1. Make sure you have Docker (with `Docker Compose`) installed.
|
|
2. Run `docker compose up -d` from this directory. It will start docker containers with Prometheus and Grafana.
|
|
3. Open [http://localhost:3000/dashboards](http://localhost:3000/dashboards). Grafana login `admin`, password `grafana`.
|
|
There will be pre-configured Clio dashboard.
|
|
|
|
If Clio is not running yet launch Clio to see metrics. Some of the metrics may appear only after requests to Clio.
|