Meerkat - A Dashboarding tool for Icinga2

See the demo at demo.meerkat.run.

Meerkat is a utility to create and share dashboards for Icinga2. It’s quick to setup and easy to use. There is a WSIWYG editor interface when you can set a background for a dashboard and start overlaying checks which update in real time by polling the Icinga2 API via the Meerkat backend.

There is a video presentation Introducing Meerkat here: https://www.youtube.com/watch?v=7S5nB67360o from Icinga Camp Berlin 2022

The main driver for Meerkat to exist is to communicate to perhaps non-technical users, the relationship between the infrastructure they are familar with, and the Icinga checks you have worked so hard to build. It can embed video and audio streams. Meerkat isn’t a replacement for a complete notification system, but should complement any NOC nicely, and let users very clearly define the checks or groups of checks they care about with context that is relevant for them.

Meerkat displays the ‘worst’ status from a group of checks, for example a world map that consists of groups of checks by country:

Or a video workflow from left to right:

This check uses the Icinga Business Process module to quickly show the overall path is OK, even if one of the paths is having problems.

Getting Started

Install Meerkat

Downloading and installing Meerkat.

Tutorial: Connecting Icinga

Connect Meerkat to Icinga to create dashboards from Icinga objects like Services and HostGroups.

Tutorial: Create a dashboard

How to make a simple dashboard.

Tutorial: Meerkat as a systemd service

Running Meerkat as a long-running service on Linux.

Using Meerkat

Dashboard Elements

A description of all the different elements which make up dashboards.

Configuring Meerkat

A reference for the Meerkat configuration file.

Operations

Notes on operating Meerkat in real, production environments; security, backup strategies, and more.

Support

Sol1 is an official Icinga Enterprise Partner, and can offer commercial support for Meerkat and Icinga and friends. We are a friendly bunch of people, so please don’t hesitate to get in touch at http://sol1.com.au

Contributing

We welcome any contributions. Let us know via the issues here if there is something you need fixed up, or even better, a patch or PR would be most appreciated.

Sounds from Notification Sounds provided under the creative commons 4.0 license

License is GNU Affero GPLv3.