nagios-parser-docker
v3.0.1
Published
Nagios parser AI
Downloads
3
Readme
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
| Endpoint | Filters | Description |
|---|---|---|
| /
| No | Returns the entire overview of Nagios |
| /info
| No | Returns the information about Nagios |
| /program
| No | Returns the informatino about running Nagios program and settings |
| /hosts/:host/services/:service
| Yes | Returns service information about the specified service on the specified host |
| /hosts/:host/services
| Yes | Returns service information about services on the specified host |
| /hosts/:host
| No | Returns host information on the specified host |
| /hosts
| Yes | Returns host information on all hosts |
| /services/:service
| Yes | Returns service information about services with the specified service name |
| /services
| Yes | Returns service information on all services |
| /contacts
| No | Returns all contact information |
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 -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.