Ouroboros Metrics

 This page is under construction  

A collection of observability tools for exporting and visualising metrics collected from Ouroboros.

Currently has one very simple exporter for InfluxDB, and provides additional visualization via grafana.

More features will be added over time.

Requirements

Ouroboros version >= 0.18.3

InfluxDB OSS 2.0

python influxdb-client, install via

pip install 'influxdb-client[ciso]'

And you might also need pytz

pip install pytz

It is highly recommended to install grafana for visualization.

Setup

Install and run InfluxDB and create a bucket in InfluxDB for exporting Ouroboros metrics, and a token for writing to that bucket. Consult the InfluxDB documentation on how to do this.

To use grafana, https://grafana.com/docs/grafana/latest/?pg=graf-resources&plcmt=get-started install and run grafana open source.

Go to the grafana UI (usually [1]) and set up InfluxDB as your datasource: Go to Configuration -> Datasources -> Add datasource and select InfluxDB Set “flux” as the Query Language, and under “InfluxDB Details” set your Organization as in InfluxDB and set the copy/paste the token for the bucket to the Token field.

To add the Ouroboros dashboard, select Dashboards -> Manage -> Import

and then either upload the json file from the metrics repository in

dashboards-grafana/general.json

or copy the contents of that file to the “Import via panel json” textbox and click “Load”.

Get the exporter

git clone https://ouroboros.rocks/git/ouroboros-metrics
cd ouroboros-metrics
cd exporters-influxdb/pyExporter/

Edit the config.ini.example file and fill out the InfluxDB information (token, org).

[influx2]
url=http://localhost:8086
org=<your-org>
token=<your-token>
timeout=6000
verify_ssl=False

Save it as config.ini.

Now you can run the exporter:

python oexport.py