From 85f3bd718e4ef07bc728db36a0bdfef44a95ba5a Mon Sep 17 00:00:00 2001 From: sanke1 Date: Sat, 16 Jun 2018 16:04:01 +0300 Subject: [PATCH] Text and eng formatting (#11) Improve readability of readme. Fix some english --- README.md | 44 ++++++++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index fa51bdd..893309b 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,48 @@ # Hastic Graph Panel -A better version of default Grafana's Graph Panel. Can render Anomalies & more. -In order to detect anomalies and make predictions, you need to install: +A better version of Grafana's default Graph Panel. Able to render Anomalies & more. + + + +# Prerequisites * [hastic-server](https://github.com/hastic/hastic-server) * [Grafana >= 5.1.1](https://grafana.com/grafana/download) - - # Installation -Clone repo +- Clone the repository ``` cd $GRAFANA_PATH/data/plugins git clone git@github.com:hastic/hastic-grafana-graph-panel.git ``` -and restart your `$GRAFANA_PATH/bin/grafana-server` server. +- Restart `$GRAFANA_PATH/bin/grafana-server` server. # Usage -You should have [hastic-server](https://github.com/hastic/hastic-server) running to use anomaly detection. +[hastic-server](https://github.com/hastic/hastic-server) should be running in order to use anomaly detection. -- open new dasboard where you want to see Hastic panel -- open Dashboard `Settings` (top right corner) and then `Varables` -- Add new `Constant` [variable](http://docs.grafana.org/reference/templating/#variable-types) with `name` equals to `HASTIC_SERVER_URL` and `value` with URL of your hastic-server instance (e.g. `http://localhost:8000`) in your dashboard +- Open new dasboard where you want to see Hastic panel +- Open Dashboard `Settings` (top right corner) and then navigate to `Variables` +- Add new [variable](http://docs.grafana.org/reference/templating/#variable-types) + - set `type` to `Constant` + - set `name` to `HASTIC_SERVER_URL` + - set `value` to URL of your hastic-server instance in your dashboard (e.g. `http://localhost:8000`) - Save settings and close Settings window -- set one metrics in `Metrics` tab. Only one metric suported -- go to `Analytics tab` and create new anomaly -- label your data: - - click button with chart icon - - highlight anomalies on graph holding `Ctrl` button on Windows or `Cmd` on Mac - - when you finished labeling - click button with chart icon once more. `saving...` status should appear. -- 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 +- Open panel edit mode (click `panel title`menu or press "e" hotkey) +- Navigate to `Metrics` tab. Set metrics. Only one metric suported +- Navigate to `Analytics tab` + - Push `Add an Anomaly Type` button + - Set name of the anomaly and choose a pattern type + - Press `create` +- Label your data: + - Click button with chart icon + - Highlight anomalies on graph holding `Ctrl` button on Windows or `Cmd` on Mac + - When you have finished labeling - click the button with the chart icon once more. `saving...` status should appear. +- `Learning` status should appear while hastic-server is learning (first learning can take a while). +- When `Learning` status dissapears - the anomalies should become labeled in your graph - this icon means that the anomaly was marked by the server - this icon means that the anomaly was marked by the user