omdclient check_mk + WATO/OMD interface
Project description
omdclient
omdclient provides a suite of tools to interact with the APIs associated
with the check_mk
/Open Monitoring Distribution tool suite
WATO APIs
WATO is used to create, remove, and modify entries within the OMD user suite. This is documented at:
http://mathias-kettner.com/checkmk_wato_webapi.html
omd-host-crud
Creates/Reads/Updates/Deletes entries from an existing monitoring interface.
omd-activate
Activates changes made by the API user.
omd-puppet-enc
Provides a linkage between a puppet External Node Classifier (ENC) and a monitoring instance. In essence, we want to add hosts to monitoring when a host is added to puppet; remove the host from monitoring when the host is removed from puppet; and re-tag the host when its role changes.
https://docs.puppetlabs.com/guides/external_nodes.html
Multisite/Nagios
https://mathias-kettner.de/checkmk_multisite_automation.html
omd-nagios-ack
Acknowledges host/service alerts from the command-line.
omd-nagios-downtime
Schedules host/service downtimes from the command-line.
omd-nagios-report
Prints a human-readable report on current host and service alerts.
How To Use
/etc/omdclient/config.yaml
You'll have to populate this file on your own:
server: 'xxxxxx.example'
site: 'xxxxxx'
user: 'xxxx-api'
apikey: 'xxxxxx'
If you set the 'OMDCONFIG' environment variable you can point at different configs, e.g.:
OMDCONFIG=/tmp/myconfig.yaml omd-activate
Configuration of 'expanded views'
The report scripts depend on 'expanded view' versions of the
hostproblems
and svcproblems
views, which add comments. In order to
add these, you generally have to:
- Edit view
hostproblems
- it's a default view, so you'll go to 'clone'.- Change the name from
hostproblems
tohostproblems_expanded
. - Scroll down to the list of columns, and add one more:
Host Comments
. - (newer versions) set to 'public' and 'hidden'.
- Save.
- Change the name from
- Edit the view
svcproblems
and createdsvcproblems_expanded
, same as above but with the columnService Comments
.
In newer versions of check_mk, you may also need to make these views
Public (check Visibility
/ Make this view available for other users
/
Publish to all users
). Also, the hostproblems
base view may have
changed: I have for hostproblems_expanded
:
- Hostname
- Host icons
- Host state
- Output of host check plugin
- Number of services in state OK
- Number of services in state WARN
- Number of services in state UNKNOWN
- Number of services in state CRIT
- Number of services in state PENDING
- The age of the current host state
- Host comments
(Thanks to Christian Bryn - https://github.com/epleterte - for the docs!)
How To Build
There is a Makefile.bak
and a *.spec
file that mirrors my local build
process for RPMs, if this matches your requirements; just run
make -f Makefile.bak build-nomock
.
Otherwise, you may want to just follow the general instructions in *.spec
.
Scripts from usr/bin/*
go into your path; create /etc/omdclient/config.yaml
as described above; make man pages with pod2man
if you're ambitious; and run
python setup.py install
to install the python library.
Debian
make -f Makefile.deb build
That should build a full .deb package.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.