ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-11 23:35:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8d875702eb18ece2c3ae2da04d44f74fecce00cd
clio/docs/examples/infrastructure/README.md
Sergey Kuznetsov 427ba47716 chore: Fix error in grafana dashboard example (#1878)
2025-02-07 13:42:30 +00:00

1.5 KiB
Raw Blame History

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 visualise 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 authorisation in Prometheus.
  • grafana/clio_dashboard.json Json file containing preconfigured 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 and 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. Grafana login admin, password grafana. There will be preconfigured Clio dashboard.

If Clio is not running yet launch Clio to see metrics. Some of the metrics may appear only after requests to Clio.