Checkmk
Effortlessly set up Checkmk integration for incident management with Squadcast. Follow our step-by-step guide for streamlined configuration.
Follow the steps below to configure a service so as to extract its related alert data from Checkmk, which is built on top of Nagios.
Squadcast will then process this information to create incidents for this service as per your preferences.
Note:
Note that you must be logged in as
root to complete the installation.These instructions might need to be altered based on your exact Linux distribution and your Checkmk version and configuration.
- 1.Navigate to Services -> Service Overview -> select or search for your Service. Expand the accordion -> In the Alert Sources section, click Add.
2. Select Checkmk. Copy the displayed Webhook URL to configure it within Checkmk. Finish by clicking Add Alert Source -> Done.
Important:
When an alert source turns Active, it’ll show up under Configured Alert Sources. You can either generate a test alert from the integration or wait for a real-time alert to be generated by the Alert Source.
An Alert Source is active if there is a recorded incident via that Alert Source for the Service.
- Go to your Checkmk server.
- Download the Squadcast notification script.
wget https://raw.githubusercontent.com/SquadcastHub/squadcast-checkmk-script/master/sq-script.py
- Move the notification script into place.
For the standalone version of Checkmk, this is usually in the below path:
/usr/share/check_mk/notificationsmv sq-script.py /usr/share/check_mk/notifications
For the OMD version of Checkmk, this is usually located in
/omd/sites/{site-name-here}/local/share/check_mk/ notifications.mv sq-script.py /omd/sites/{site-name-here}/local/share/check_mk/notifications
- Then give the script execute permission.
chmod +x sq-script.py
- Log in to the Checkmk web interface, go to Users (located in the WATO· Configuration box) and click New User
- Enter a Username and, optionally, a Full name for the Squadcast user.
Pro Tip:
You will find it beneficial to set the full name to match the name of your Squadcast service if you will plan to configure Checkmk hosts and services to alert multiple Squadcast services and not just one.
- Do not enter a password for this user; instead check
disable the login to this account. This step is done as this account exists solely to send notifications to the Squadcast script. - Set the user’s role to
Normal monitoring user, or any custom role you’ve created with permissions to send notifications. - Add the user to the Contact Groups which are a part of the hosts/services that you want to receive alerts for. Click Save when you are done.
- Click the Notifications icon (bell icon) for the user created.
- Enter a Description for the new notification method, then set Notification Method to Squadcast.
- Paste the Webhook URL you copied from Squadcast earlier in the text box that appears once you select Squadcast, and select any desired conditions to limit the alerts that get sent to Squadcast. Click Save when you are done.
- Go back to the Users list and click Changes, then click Activate Changes.
- Congratulations! When you see "Configuration successfully activated" you are done! Checkmk will now be able send alerts into Squadcast.
You can test the integration to make sure everything works as expected by going to a host or service in the Checkmk interface and clicking the Execute icon (hammer).
- In the Fake check results box, click Critical (if on a service) or Down (if on a host), then click
Yes!to confirm that you want to send the fake alert. - You should see a new incident created in Squadcast.
Note:
This integration has been tested with Checkmk version 1.6. However, this integration should work with other existing versions as well, just with slight UI differences.
Last modified 1mo ago