Plugins 〉Alarm Box


Developer

BT Plc


Sign up to receive occasional product news and updates:



The Alarm Box plugin has been deprecated and is no longer maintained.

Panel
community

Alarm Box

  • Overview
  • Installation
  • Related content

Grafana Alarm Box

An alarm box panel for Grafana.

Alarm Box Panel

This panel shows the total count of values across all series. This is useful if you want to show a total count of alarms. Options for this panel include variable font sizes; a drilldown link for the entire panel; and color thresholds for the value.

Values

A separate tab allows you to customize how the display and color values are calculated, using mathjs.

Alarm Box Values

In addition to the data array, the initial scope also includes a now value, which is set to Date.now().

Compatibility

This panel should work with the following data sources: Graphite, Elasticsearch

Development

Docker is an easy way to spin-up an instance of Grafana. With docker installed, run the following command in the directory containing the plugin; this will expose the local plugin on your machine to the Grafana container so you can test it out.

docker run -it -v $PWD:/var/lib/grafana/plugins/alarm_box -p 3000:3000 --name grafana.docker grafana/grafana

Now do this...

# Install development packages
npm install

Install the grunt-cli

sudo npm install -g grunt-cli

Compile into dist/

grunt

Restart Grafana to see it

docker restart grafana.docker

Watch for changes (requires refresh)

grunt watch

Use grunt test to run the Jasmine tests for the plugin; and grunt eslint to check for style issues. Note that the plugin controller isn't tested because it depends on Grafana native libraries, which aren't available outside of Grafana.

Contributing

For bugs and new features, open an issue and we'll take a look. If you want to contribute to the plugin, you're welcome to submit a pull request - just make sure grunt runs without errors first.

Installing Alarm Box on Grafana Cloud:

For more information, visit the docs on plugin installation.