diff --git a/src/README.md b/src/README.md index 0a46d69..1a5261a 100644 --- a/src/README.md +++ b/src/README.md @@ -1,51 +1,63 @@ - +This datasource lets you use the Alertmanager's API of Prometheus to create dashboards in Grafana. -# Grafana Prometheus Alertmanager Datasource +![Overview](https://raw.githubusercontent.com/camptocamp/grafana-prometheus-alertmanager-datasource/master/src/img/overview.png) -Grafana datasource for the prometheus alertmanager +# Usage - +Whether the alerts gathered should be silenced. + +### Inhibited + +Whether the alerts gathered should be inhibited. + +![Parameters](https://raw.githubusercontent.com/camptocamp/grafana-prometheus-alertmanager-datasource/master/src/img/table.png) + +# Panels + +## Stat + +To use stat panels, you must apply a transformation to your metrics: + +1. Edit your panel and open the "Transform" tab. + +![Transform tab](https://raw.githubusercontent.com/camptocamp/grafana-prometheus-alertmanager-datasource/master/src/img/singlestat-transform.png) + +2. Select "Reduce" and change the "Calculations" to "Count" + +![Reduce transformation](https://raw.githubusercontent.com/camptocamp/grafana-prometheus-alertmanager-datasource/master/src/img/singlestat-reduce.png) + +# Development Setup + +Usage of Yarn is encouraged to build. + +```shell +$ yarn install +$ yarn run build +```