nagios-parser-docker-api

In order to read the status of our nagios servers, we use the following service, which runs within docker. It exposes the status of nagios through HTTP in a sensible way.

Endpoints

Method	Endpoint	Filters	Description
GET	/	No	Returns the entire overview of Nagios
GET	/info	No	Returns the information about Nagios
GET	/program	No	Returns the informatino about running Nagios program and settings
GET	/hosts/:host/services/:service	No	Returns service information about the specified service on the specified host
POST	/hosts/:host/services/:service	-	Submit a service check for the specified host and service
GET	/hosts/:host/services	Yes	Returns service information about services on the specified host
GET	/hosts/:host	No	Returns host information on the specified host
GET	/hosts	Yes	Returns host information on all hosts
GET	/services/:service	Yes	Returns service information about services with the specified service name
GET	/services	Yes	Returns service information on all services
GET	/contacts	No	Returns all contact information

Encoding

Note that host and service names are case-sensitive. In case host or service names contain special characters, these need to be encoded (use the Javascript implementation of encodeURIComponent for this).

Websockets

You can also enable --with-ws as a command line flag. The service will start with a websockets endpoint at /. This will send you either update-hosts or update-services if their state changed significantly.

Notifications will be sent for the following changes:

• New services or hosts added,
• Services or hosts were removed,
• A host or services state changed,
• A host or service state changed (HARD/SOFT),
• Notifications will be surpressed for flapping hosts and services.

CORS

For easier integration (as you should only expose this data on your internal network), you can accept all Origins for CORS. Pass the flag --allow-all-cors for this to the script.

Filters

Filter	Values	Description
state	OK, WARNING, CRITICAL, UNKNOWN	Only show services or hosts which match the speficied state. Prepend with ! for a negation. So !OK will return all non-OK services or hosts
flapping	true, false, 1, 0	Only show services or hosts which are currently flapping (or not)

Running it

You can start it as follows docker run -v /var/cache/nagios3/:/opt/nagios -v /var/lib/nagios3/rw/:/opt/commands -p 8080:8080 magnetme/nagios-parser-docker-api:latest. In this case you can just execute http://localhost:8080 to see all of nagios' data in JSON format.