Skip to content

check-mk.md

Latest commit

 

History

History
165 lines (106 loc) · 6.52 KB

check-mk.md

File metadata and controls

165 lines (106 loc) · 6.52 KB
title Check_MK Integration
seoTitle iLert: Check_MK Integration for Alerting | Incident Response | Uptime
description The iLert Check_MK Integration helps you to easily connect iLert with Check_MK.
date 2018-12-29T05:02:05.000Z
weight 1

Check_MK Integration

With the iLert Check_MK notification plugin you can easily integrate Check_MK into iLert and extend your existing Check_MK system with SMS, push and voice notifications as well as on-call schedules from iLert. The screenshots below are based on the Check_MK Raw Edition (CRE) 1.2.8. The iLert Check_MK plugin is compatible with all Check_MK versions.

In iLert: create alert source

  1. Create a new alert source in iLert

  1. Select the type Nagios / Icinga and click save.

  1. An API key is generated. You will need the API conclusions below when setting up the plugin.

In Check_MK: configure iLert Plugin

Download the Check_MK plugin package and unzip it:

> wget https://github.com/iLert/ilert-nagios/archive/v1.5.zip
> unzip ilert-nagios-1.5.zip

For Check_MK you need the two files ilert_nagios.py and ilert_check_mk.sh. You can delete the remaining files in the directory. Move the plugin file ilert_nagios.py into the directory /usr/local/bin . Both files must be executable by both Check_MK and the cron daemon:

> mv ilert_nagios.py /usr/local/bin
> chmod 755 /usr/local/bin/ilert_nagios.py
> chmod 755 ilert_check_mk.sh

{% tabs %} {% tab title="Standalone version of Check_MK" %} If you are using the standalone version of Check_MK, follow the instructions below. If you are using the OMD version, please go the tab OMD version of Check_MK.

> crontab -u nagios -e

Add the following entry:

* * * * * /usr/local/bin/ilert_nagios.py -m send

Via this cron job, events are sent to iLert every minute that failed in the first send attempt (e..g due to a network error).

Move the iLert alerting script to the notifications directory of Check_MK:

> mv ilert_check_mk.sh /usr/share/check_mk/notifications

{% endtab %}

{% tab title="OMD version of Check_MK" %} If you are using the OMD version of Check_MK, follow the instructions below.

> su - {site-name}

Create a file named ilert under the cron.d directory of your monitoring instance (e.g. /omd/sites/{site-name}/etc/cron.d). The file should contain the following content:

* * * * * /usr/local/bin/ilert_nagios.py -m send

Execute the following command for the changes to take effect:

> omd reload crontab 
> exit

Move the iLert alerting script to the notifications directory of Check_MK:

> mv ilert_check_mk.sh /omd/sites/{site-name}/local/share/check_mk/notifications

{% endtab %} {% endtabs %}

Log in to Check_MK's web GUI and continue there.

  1. Navigate to the "Users" menu and click on "New User".

  1. Fill in the fields marked below. Add the user to the contact groups to which the hosts or services that you want to be alerted for. Click on "Save".

  1. Go to the notification settings of this user (by clicking on the "Notifications" icon).

  1. Click on "New Rule" and select iLert Check_MK Plugin as the "Notification Method". Enter your iLert API key (see above) as a parameter.

  1. Go back to the user list and activate your changes by clicking on "1 Changes":

Test the integration

You can test the integration directly in Check_MK to verify that everything is working. To do this, open a host or service check in the Web GUI and click on the "Execute" icon (Hammer Icon). In "Fake check results" you can manually set the state of a host or service. Click on "Down" (for a host) or "Critical" (for a service) and then confirm with "Yes!". You should now see an incident in iLert.

FAQ

Which alarm types (Notification Types) are processed by the plugin?

The plugin processes the notification types PROBLEM , ACKNOWLEDGEMENT and RECOVERY. The remaining Notification Types (including FLAPPING* and DOWNTIME*) are ignored.

Check_MK has the following alarm types:

Types Description
PROBLEM Normal host or service problem
RECOVERY Host / service goes UP / OK again
ACKNOWLEDGMENT Acknowledgment of a problem
FLAPPINGSTART A host / service begins to be discontinuous
FLAPPINGSTOP End of discontinuity
DOWNTIMESTART Start of scheduled maintenance.
DOWNTIMEEND Normal end of maintenance
DOWNTIMECANCELLED Premature termination of maintenance
CUSTOM Alarm triggered manually by command
ALERT HANDLER Alerthandler execution (CEE from 1.4.0i2)

What happens if my internet connection is lost? Are the events generated in Check_MK lost?

No, events won't be lost. The plugin stores the events locally in a temporary directory (by default in /tmp/ilert_nagios) and tries to send them to iLert every minute. This means that as soon as your connection is available again, cached events will be sent to iLert. In addition, we recommend that you monitor your Internet connection using our uptime monitoring feature.

Will incidents in iLert be resolved automatically?

Yes, as soon as the state of a host / service is UP or OK again in Check_MK, the associated incident is resolved in iLert. If a problem is acknowledged in Check_MK, the associated incident in iLert is set to the status Accepted.

Can I link Check_MK to multiple alert sources in iLert?

Yes, create a Check_MK user for each alert source in Check_MK. Proceed as described above in the instructions.

The plugin does not work. How do I find the issue?

Please look first in the log file. The plugin uses the Unix / Linux system log for logging (eg under /var/log/messages or /var/log/syslog ). If you can not find the error, please contact our support at support@ilert.com .

Please also have a look at the Check_MK documentation, where additional log files related to alerting are documented: The course of a notification from beginning to end