Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Latest commit

 

History

History
121 lines (77 loc) · 3.08 KB

README.md

File metadata and controls

121 lines (77 loc) · 3.08 KB
Raw

Name

Nagira -- Nagios RESTful API

Version {include:file:version.txt}

Build Status

Description

Light-weight web services RESTful API for Nagios monitoring.

  • read and update (R/W):
    • status of
      • hosts
      • services
      • hostgroups
      • servicegroups
  • read-only (R/O) access to:
    • configuration of
      • hosts
      • services,
      • contacts,
      • hostgroups
      • servicegroups
      • contactgroups, etc.
    • Nagios server
      • configuration
      • runtime environment

Source Code

Source code available from Github https://github.com/dmytro/nagira

Installation

As Docker container

To pull and run from public Docker registry run as:

docker run -d -p 4567:4567 -v /etc/nagios3:/etc/nagios3 \
  -v /var/cache/nagios3:/var/cache/nagios3 \
  -v /var/lib/nagios3:/var/lib/nagios3 ortym/nagira

As Ruby gem

    gem install nagira

For more details look at {file:INSTALL.md}

Usage

  1. Run Sinatra application nagira
  2. Use HTTP client to get information:
   curl http://localhost:4567/_objects/contact/_list

   curl http://localhost:4567/_status/_list

or to send check result to Nagios:

curl -X PUT -H "Content-type: application/json;" \
    -d @host_check.json http://nagios.example.com:4567/_status/web_server


 {
  "status_code":"0",
  "plugin_output" : "ping OK"
 }

See more in {file:FEATURES.rdoc} and API documentation in {file:API.md}

How and why?

Provide simple and consistent way for information exchange with Nagios

  1. Provide read-only access to the object configuration and object states by reading Nagios data files: status.dat and objects.cache, and
    • objects.cache file keeps information about Nagios configuration (lists of servers, services, groups etc);
    • status.dat file is file that stores information about current state of the objects (hosts and services) and Nagios process itself;
    • Nagios configuration information is in nagios.cfg file, by reading and parsing this file all other configuration can be obtained.
  2. provide check result submission interface (similar to Nagios NSCA and for setting/updating Nagios configuration.

File parsing is implemented in the background thread on a regular intervals, so that parsed information is available immediately when HTTP request comes.

Documentation

YARD documentation included with the project, run yardoc in project root directory. Generated YARD docs are available at http://dmytro.github.com/nagira_docs

Unformatted Markdown file in the project's docs directory.

API Documentation

API endpoints are partially documented in the inline comments and accessible in YARD documents (Nagira class), most of the enpoints are documented in {file:API}.

Author

Dmytro Kovalov, [email protected]

2011, Dec, 26th - started

License

MIT, see {file:LICENSE.rdoc}

Contributing

If you want to contribute feature, send a bug fix, or simply report a bug or requet a feature see {file:CONTRIBUTING.md}.