diff --git a/README.md b/README.md index 3186dc3..dd5884d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -### Development +# Statusmap panel for Grafana + + + +![Statusmap sample panel](https://raw.githubusercontent.com/flant/grafana-statusmap/master/src/img/grafana-statusmap-panel.png) + + +## Features + +* Group values into rows and buckets by query's legend +* User defined color mapping +* Multiple values in bucket display in tooltip +* Interval shaping to better visual representation +* Represent null values as empty bucket or as zero + +Supported / Tested Data Sources : +-------------------------------- + +* Prometheus +* TestData + +Tested Grafana versions : +------------------------- + +* 5.1.3 + +## Development ``` docker run --rm -it -v $PWD:/var/lib/grafana/plugins/status-heatmap-panel \ @@ -11,9 +37,13 @@ docker run --rm -it -v $PWD:/var/lib/grafana/plugins/status-heatmap-panel \ grunt watch ``` -Prometheus +### Acknowledgements + +This panel plugin is based on "Heatmap" panel by Grafana with ideas from Carpet plot, Discrete panel, Status Panel, Status Dot, Status By Group. + +#### Changelog + +##### v0.0.1 + +- First public release -``` -ssh kube-cluster -L 3001:localhost:9001 -kubectl port-forward prometheus-0 9001:9090 -n prom-namespace -``` diff --git a/src/img/grafana-statusmap-panel.png b/src/img/grafana-statusmap-panel.png new file mode 100644 index 0000000..705b7d5 Binary files /dev/null and b/src/img/grafana-statusmap-panel.png differ