Integrate with Checkmk

This article explains integrating Compass with Checkmk 1.5.0 and earlier versions. If you're using Checkmk 1.6.0 and above you can use a default Compass API integration to create this integration. Find out how to create a default API integration.

What does the integration offer?

Use Compass’s Checkmk Integration to forward Checkmk notifications to Compass. Compass determines the right people to notify based on on-call schedules– notifies via email, text messages (SMS), phone calls and iOS & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

• When a host or service state becomes down in Checkmk, an alert is created in Compass.

• When the problem is acknowledged in Checkmk, the alert is acknowledged in Compass.

• When the state of host becomes UP or the state of service becomes OK again in Checkmk, the alert is closed in Compass.

Set up the integration

Checkmk is an API integration. Setting it up involves the following steps:

• Add a Checkmk integration in Compass

• Configure the integration in Checkmk

Add a Checkmk integration

To add a Checkmk integration in Compass, complete the following steps:

1. Go to your team’s operations page.

2. On the left navigation panel, select Integrations and then Add integration.

3. Run a search and select “Checkmk”.

4. On the next screen, enter a name for the integration.

5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

6. Select Continue.
   The integration is saved at this point.

7. Expand the Steps to configure the integration section and copy the integration URL.
   You will use this URL while configuring the integration in Checkmk later.

8. Select Turn on integration.
   The rules you create for the integration will work only if you turn on the integration.

Configure the Checkmk plugin

To configure the Checkmk plugin, complete the following steps:

1. Download the Checkmk integration plugin.

2. Grant permissions as necessary to the script by using the following command:
   
   

   sudo chmod +x jsm

3. Copy the plugin into

   1. /omd/sites/[site name]/local/share/check_mk/notifications/, if you're using OMD version.

   2. /usr/share/check_mk/notifications, if you're using standalone version.

Configure the integration in Checkmk

To configure the integration in Checkmk, complete the following steps:

1. In Checkmk, select Users on the left under the WATO Configuration box.

2. Select New User at the top.

3. Enter a username and a full name for this new user.

4. Leave the Authentication part blank and check disable the login to this account to value.

5. Select Normal monitoring user for the Roles.

6. Select Save.

7. After creating the new user, you are redirected to Users page again.

8. Select the notification button under Actions column for the newly created user.

9. Select New Rule at the top.

10. Enter JSM for the Description.

11. Select JSM as the Notification Method.
    Note: Due to an issue with Checkmk, you'll see two entries. The one which asks for Call with forwarding parameters is the correct one. Avoid using the one which asks for API key.

12. Paste the API URL copied previously into the textbox under Call with the following parameters: combobox.

13. Select Save.

14. After saving, select Main Menu on the left under WATO Configuration box.

15. Select the orange button labeled # Changes at the top.

16. Select Activate Changes at the top of the newly opened page.

Sample webhook message from the Checkmk plugin

JSON