Statusmap panel for Grafana

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 value

Supported environment

• Prometheus datasource
• Tested with Grafana 5.1.3

Installation

Plugin can be installed with git:

git clone git@github.com:flant/grafana-statusmap.git /var/lib/grafana/plugins/flant-statusmap-panel

Or you can download ZIP archive of this repo and unpack it into /var/lib/grafana/plugins directory.

Motivation

This plugin emerges from our needs to visually represent history of changes for a set of objects with discrete statuses. Objects can be hosts, Kubernetes pods or coffee makers and discrete statuses are a set of predefined values: something like ok = 0, off = 1, fail = 2.

Configuration

Prometheus

Discrete statuses requires some setup in prometheus to get all available statuses over time. If metric has values 0 and 1 and status is stored in label then it's ok. But if there are 5 statuses and metric has possible values (0,1,2,3,4) then it should be transformed into previous form with this rule:

- record: coffee_maker_status:discrete
  expr: |
    count_values("status", coffee_maker_status)

This rule will transform metric coffee_maker_status with value 3 into this new metric:

coffee_maker_status:discrete{status="3"} 1

Now prometheus has 0 and 1 for each status. And these metrics can be aggregated to get all available statuses over time.

Panel

Each possible status value corresponds to a separate query. Each query should have similar legend for grouping.

Next define color mapping for status values in Discrete color mode.

Spectrum and Opacity color modes works as in a Heatmap plugin.

More options

Multiple values check determine multiple values display mode. If check is unset then multiple values for one bucket treated as error. If check is on then color for bucket determined by value with least index in color mapping.

Null values can be treated as empty buckets or displayed as color of 0 value.

Min width and spacing are determine minimal bucket width and spacing between buckets. Rounding is for round edges.

Development

The easy way to test and develop plugin is to run Grafana instance in docker with following command in the directory containing the plugin. This will expose the local plugin on your machine to the Grafana container.

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

Now run grunt to compile dist directory and start changes watcher:

grunt watch

Acknowledgements

Idea of a plugin comes from Dmitry Stolyarov @distol, initial version written by Sergey Gnuskov @gsmetal and final changes made by Ivan Mikheykin @diafour.

This plugin is based on a "Heatmap" panel by Grafana and inspired by ideas from Carpet plot, Discrete panel, Status Panel, Status Dot, Status By Group.

Changelog

v0.0.1

• First public release