Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Nagios/Shinken plugins for Elasticsearch

branch: master
README.textile

check-es

Nagios/Shinken plugins for checking out on Elasticsearch

For now there are two of them:

  • check_es_insert.py – gives you the number of new documents indexed per second
  • check_es_docs.py – gives the total number of documents

The second depends on the first, so you need to install both (in the same directory) if you want to use the second only.

Installation

  • Copy the plugins in your Nagios plugins directory (usually /usr/lib/nagios/plugins)
  • Make sure they can be executed by whatever runs them (Nagios/Shinken/NRPE)

For using the plugin from Shinken directly (I bet it’s the same with Nagios)

  • edit /etc/shinken/commands.cfg and add something like this:
define command{
  command_name    check_es_docs
  command_line    /usr/local/shinken/libexec/check_ping -w 5000000 -c 10000000 -a elasticserver:9200
}
  • edit the host configuration file for the host you want to monitor (eg: /etc/shinken/hosts/localhost.cfg), and add a service like this:
define service{
  host_name    linuxbox
  service_description    TotalESDocuments
  check_command    check_es_docs
  #other options, if you want
}
  • restart Nagios/Shinken and it should work

For running the plugin remotely via NRPE

  • define the command in NRPE’s config (eg: make a new file /etc/nagios/nrpe.d/check_es.cfg and make sure it’s readable by nagios:nagios), that looks something like this:
command[check_es_docs]=/usr/lib/nagios/plugins/check_es_docs -w 5000000 -c 10000000
  • restart NRPE server
  • edit the host configuration file for the host you want to monitor (eg: /etc/shinken/hosts/localhost.cfg), and add a service like this:
define service{
  host_name    linuxbox
  service_description    TotalESDocuments
  check_command    check_nrpe!check_es_docs
  #other options, if you want
}
  • restart Nagios/Shinken and it should work

Command-line arguments

Run the plugins with

—help
for more information. But the idea is:
-c for the Critical value
-w for the Warning value
-a for the address of the Elasticsearch server to check on (host:port)
-f for the file to store previous results on (check_es_insert only)
Something went wrong with that request. Please try again.