icinga2-burrow-plugin

A plugin for Icinga2 to access the Burrow API to get a total count of unread messages (lag) of all consumers in all clusters. The plugin supports three parameters:

1. Burrow API Base URL e.g. http://1.2.3.4:9991/v3
2. Warning threshold
3. Critical threshold
4. Excluded consumer groups (comma separated)

It returns a message in a Icinga2 supported format: OK - ..., WARNING - ..., CRITICAL - ...

Check out their wiki for more information about the API ressources used by the script.

Usage

You have to clone the plugin e.g. in the /usr/lib/nagios/plugins folder and install it:

git clone https://github.com/egodigital/icinga2-burrow-plugin.git
cd icinga2-burrow-plugin
npm install

Change the location in the run file, if you used another path and define an Icinga2 command like this:

object CheckCommand "check_kafka_lag" {
  command = [ PluginDir + "/icinga2-burrow-plugin/run" ]

  arguments = {
    "-u" = "$burrow_base_url$"
    "-w" = "$warning_threshold$"
    "-c" = "$critical_threshold$"
    "-e" = "$excluded_consumer_groups$"
  }
}

Change the path to another folder, if you cloned it somewhere else.

Define a Host that uses the check_kafka_lag command:

object Host "some-host" {
  import "generic-host"
  
  check_command = "check_kafka_lag"

  vars.os = "Linux"

  vars.burrow_base_url = "http://1.2.3.4:9991/v3"
  vars.warning_threshold = "10000"
  vars.critical_threshold = "50000"
  vars.excluded_consumer_groups = "some_consumer_group"
}

Don't worry about not knowing about a lot of unread messages by your comsumers.