From ee00008deaebf5d6f187a7da31ada6d36683288c Mon Sep 17 00:00:00 2001 From: Alexey Velikiy Date: Thu, 24 May 2018 14:49:44 +0300 Subject: [PATCH] add usage docs --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 8e4502a..254fd32 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,20 @@ git clone git@github.com:hastic/hastic-grafana-graph-panel.git and restart your `$GRAFANA_PATH/bin/grafana-server` server. +# Usage + +You should have [hastic-server](https://github.com/hastic/hastic-server) running to use anomaly detection. + +- set [template variable](http://docs.grafana.org/reference/templating/) `$backendUrl` with URL of your hastic-server instance (e.g. `http://localhost:8000`) in your dashboard +- set metrics in `Metrics` tab +- go to `Analytics tab` and create new anomaly +- label your data: + - click button with chart icon + - highlight anomalies on graph holding Ctrl button + - when you finished labeling - click button with chart icon once more +- you should see `Learning` status while hastic-server is learning (first learning can take a while) +- when `Learning` status dissapear - you should see anomalies labeled in your graph + # Development