Browse Source

update docs

pull/2/head
vargburz 2 years ago
parent
commit
e221551ac9
  1. 30
      README.md

30
README.md

@ -14,7 +14,35 @@
- Bar Chart (coming soon) - Bar Chart (coming soon)
- Gauge: dynamic thresholds and min / max - Gauge: dynamic thresholds and min / max
- Gauge: conditional icons displaying - Gauge: conditional icons displaying
- Gauge: reversed direction
## How to use
1. Create a new panel and select Chartwerk as the visualization
2. Add multiple queries with a unique alias
3. Go to the Options Tab and setup panel:
- Choose visualization type (Gauge is the only available option for now)
- Select metric in the Value -> Metric dropdown (the first query metric will be used as a default one)
## Demo
see [demo](https://grafana.corpglory.com/d/8vGyMypGz/demo-home?orgId=4)
## Options [Gauge]
- Visualization:
- Pod: option to select chart type
- Value:
- Metric: select metric query from dropdown
- Extemum:
- Min:
- type number for static minimum value OR
- enable "Use metric" toggle switch to select metric as minimun
- default value: 0
- Max:
- type number for static maximum OR
- enable "Use metric" toggle switch to select metric as maximum
- default value: maximum of metric query
## Installation ## Installation
### Linux / Mac OS X ### Linux / Mac OS X

Loading…
Cancel
Save