mirror of
https://github.com/timberjoegithub/grafana-statusmap.git
synced 2026-07-21 23:42:03 +00:00
175 lines
6.8 KiB
Markdown
175 lines
6.8 KiB
Markdown
# Statusmap panel for Grafana
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
* Grouping values into rows and buckets using legend from query
|
|
* User defined color mapping
|
|
* Multiple values in bucket are displayed via tooltip
|
|
* Increasing rows/buckets' interval for better visual representation
|
|
* Representing null values as empty bucket or zero value
|
|
|
|
### Supported environment
|
|
|
|
* Prometheus datasource
|
|
* Tested with Grafana 5.1.3
|
|
|
|
## Installation
|
|
|
|
Plugin can be installed with GF_INSTALL_PLUGINS="flant-statusmap-panel" or you can use Git and clone this repo:
|
|
|
|
```
|
|
git clone git@github.com:flant/grafana-statusmap.git /var/lib/grafana/plugins/flant-statusmap-panel
|
|
```
|
|
|
|
Alternatively, you can download [ZIP archive](https://github.com/flant/grafana-statusmap/archive/master.zip)
|
|
of this repo and unpack it into /var/lib/grafana/plugins directory.
|
|
|
|
|
|
## Motivation
|
|
|
|
We had a desperate need to visualize a set of timeseries statuses over time period, so we can
|
|
see a history of changes for objects' status. Since we maintain a lot of Kubernetes clusters
|
|
(and related infrastructure), our main cases for that are visualization of servers & Kubernetes
|
|
pods health states as well as HTTP services health checks. We've tried a variety of Grafana
|
|
plugins available (they are listed in *Acknowledgements* below) but none of them could provide
|
|
the features and visualization really close to what we've been looking for.
|
|
|
|
_NB: You can find more details about our journey of creating the plugin in
|
|
[this post](https://medium.com/flant-com/statusmap-grafana-plugin-to-visualize-status-over-time-fe6ced391853)._
|
|
|
|
_Objects_ being visualized with this plugin may be different: not only IT components (e.g. server
|
|
hosts and Kubernetes pods) but just anything you can imagine like coffee makers on the picture
|
|
above. These objects should have _discrete statuses_ which are sets of predefined values, e.g.
|
|
`ok` = 0, `off` = 1, `fail` = 2, etc.
|
|
|
|
## Configuration
|
|
|
|
### Prometheus
|
|
|
|
To work with data from Prometheus you will need to setup discrete statuses for your objects.
|
|
Requirements to store these statuses in metrics are as follows:
|
|
* metrics should have two values: `0` and `1`;
|
|
* there should be a label with status' value.
|
|
|
|
When it's done, you can collect all the data via query, e.g.:
|
|
|
|
```
|
|
(max_over_time(coffee_maker_status{status="<STATUS_VALUE>"}[$__interval]) == 1) * <STATUS_VALUE>
|
|
```
|
|
|
|
If there was no such status (`<STATUS_VALUE>`) during query's interval, Prometheus would
|
|
return nothing. Otherwise, status' value will be returned.
|
|
|
|
For example, if you have 5 types of statuses and a metric (`coffee_maker_status`) with 5
|
|
allowed values (`0`, `1`, `2`, `3`, `4`), you should transform this metric using following rule:
|
|
|
|
```
|
|
- record: coffee_maker_status:discrete
|
|
expr: |
|
|
count_values("status", coffee_maker_status)
|
|
```
|
|
|
|
That's how `coffee_maker_status` metric with value `3` will be transformed into new metric:
|
|
|
|
```
|
|
coffee_maker_status:discrete{status="3"} 1
|
|
```
|
|
|
|
Now, when Prometheus has `0` and `1` values for each status, all these metrics can be
|
|
aggregated, so you will get all available statuses of your objects over time.
|
|
|
|
### Panel
|
|
|
|
First of all, an individual query for each possible status' value should be created.
|
|
Each query should also have similar legend for grouping:
|
|
|
|
|
|
|
|
Then, color mapping for status' values should be defined in __Discrete__ color mode:
|
|
|
|
|
|
|
|
Use can use presets to define a trafic light colors or 8 colors from solarized palette:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_Note: __Spectrum__ and __Opacity__ color modes function the same way they do in [Heatmap](https://grafana.com/plugins/heatmap) plugin._
|
|
|
|
|
|
### More options
|
|
|
|
|
|
|
|
__Multiple values__ checkbox specifies how they should be displayed:
|
|
* If it's off, multiple values for one bucket are treated as error;
|
|
* If it's on, color for such bucket would be determined by the value having least index in color mapping.
|
|
|
|
|
|
|
|
__Null values__ can be treated as empty buckets or displayed with the color of `0` value.
|
|
|
|
|
|
|
|
__Min width__ and __spacing__ are used to specify minimal bucket width and spacing between buckets.
|
|
__Rounding__ may be used to round edges.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
To test and improve the plugin you can run Grafana instance in Docker using following command (in
|
|
the directory containing Statusmap plugin):
|
|
|
|
```
|
|
docker run --rm -it -v $PWD:/var/lib/grafana/plugins/flant-statusmap-panel \
|
|
-p 3000:3000 --name grafana.docker \
|
|
--env=GF_USERS_DEFAULT_THEME=light \
|
|
grafana/grafana:5.1.3
|
|
```
|
|
|
|
This will expose local plugin from your machine to Grafana container. Now run `grunt` to compile
|
|
dist directory and start changes watcher:
|
|
|
|
```
|
|
grunt watch
|
|
```
|
|
|
|
## Acknowledgements
|
|
|
|
The first public release of this plugin has been fully made by [Flant](https://flant.com/) engineers. The whole idea has come from Dmitry Stolyarov ([@distol](https://github.com/distol)), initial version has been written by Sergey Gnuskov ([@gsmetal](https://github.com/gsmetal)) and final changes has been made by Ivan Mikheykin ([@diafour](https://github.com/diafour)).
|
|
|
|
This plugin is based on "Heatmap" panel by Grafana and partly inspired by ideas from Carpet plot, Discrete panel, Status Panel, Status Dot, Status By Group.
|
|
|
|
#### Changelog
|
|
|
|
##### v0.0.3
|
|
|
|
- Add solarized preset
|
|
- Reorganize statuses editor for discrete mode
|
|
- Separate options for vertical and horizontal spacing for cards
|
|
- Add simple sort options for Y axis
|
|
- Fix display null values as zero
|
|
|
|
##### v0.0.2
|
|
|
|
- Install with GF_INSTALL_PLUGINS
|
|
- Fix legend overlap
|
|
- Fix colors for dark theme
|
|
- Fix panel rendering timeout error
|
|
|
|
|
|
##### v0.0.1
|
|
|
|
- First public release
|