Browse Source

Text and eng formatting (#11)

Improve readability of readme. 
Fix some english
master
sanke1 6 years ago committed by Alexey Velikiy
parent
commit
85f3bd718e
  1. 44
      README.md

44
README.md

@ -1,40 +1,48 @@
# Hastic Graph Panel # Hastic Graph Panel
A better version of default Grafana's Graph Panel. Can render Anomalies & more. A better version of Grafana's default Graph Panel. Able to render Anomalies & more.
In order to detect anomalies and make predictions, you need to install:
<img src="https://hastic.io/images/cpu_white.gif" />
# Prerequisites
* [hastic-server](https://github.com/hastic/hastic-server) * [hastic-server](https://github.com/hastic/hastic-server)
* [Grafana >= 5.1.1](https://grafana.com/grafana/download) * [Grafana >= 5.1.1](https://grafana.com/grafana/download)
<img src="https://hastic.io/images/cpu_white.gif" />
# Installation # Installation
Clone repo - Clone the repository
``` ```
cd $GRAFANA_PATH/data/plugins cd $GRAFANA_PATH/data/plugins
git clone git@github.com:hastic/hastic-grafana-graph-panel.git 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 # 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 new dasboard where you want to see Hastic panel
- open Dashboard `Settings` (top right corner) and then `Varables` - Open Dashboard `Settings` (top right corner) and then navigate to `Variables`
- 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 - 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 - Save settings and close Settings window
- set one metrics in `Metrics` tab. Only one metric suported - Open panel edit mode (click `panel title`menu or press "e" hotkey)
- go to `Analytics tab` and create new anomaly - Navigate to `Metrics` tab. Set metrics. Only one metric suported
- label your data: - Navigate to `Analytics tab`
- click button with chart icon - Push `Add an Anomaly Type` button
- highlight anomalies on graph holding `Ctrl` button on Windows or `Cmd` on Mac - Set name of the anomaly and choose a pattern type
- when you finished labeling - click button with chart icon once more. `saving...` status should appear. - Press `create`
- you should see `Learning` status while hastic-server is learning (first learning can take a while). - Label your data:
- when `Learning` status dissapear - you should see anomalies labeled in your graph - 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
- <img src="assets/mag_icon_light.png" /> this icon means that the anomaly was marked by the server - <img src="assets/mag_icon_light.png" /> this icon means that the anomaly was marked by the server
- <img src="assets/pin_icon_light.png" /> this icon means that the anomaly was marked by the user - <img src="assets/pin_icon_light.png" /> this icon means that the anomaly was marked by the user

Loading…
Cancel
Save