Icinga Notifications

The built-in Icinga Notifications trigger initiates flows when it receives a request from a webhook in Icinga. xMatters includes two Icinga triggers: one for Icinga Host Notifications and one for Icinga Service Notifications. You can include both trigger types on the same canvas if required, but signals from Icinga host notifications will not trigger Icinga service notification flows, and vice versa.

Add the trigger to the canvas

  1. Go to the Triggers tab in the palette, expand the App Triggers section, and then drag either the Icinga Host Notifications or Icinga Service Notifications trigger onto the canvas.
  2. Double-click the trigger (or click the pencil icon).
  3. Set the authenticating user, and then copy the URL — you'll use this to set up the webhook in Icinga. Alternatively, you can create an integration user to use as the authenticating user.

  4. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.
  5. Connect the steps you want to run when xMatters receives a request to that URL.

You're now ready to configure Icinga to target the trigger.

Configure Icinga to send requests to the trigger URL

The following instructions describe how to configure Icinga to send signals to your triggers.

  1. Download the xm-host-notification.sh, xm-service-notification.sh, and xmatters-plugin.conf files to your computer.
  2. Go to the location of your Icinga scripts folder. For example: /etc/icinga/scripts.
  3. Add both shell files to the scripts folder.
    • If you're using Basic Authentication, open each shell file and add -u <username>:<password> to the cURL command and insert your username and password. For example: 
      #!/bin/shecho 

      "Sending xMatters host notification."
      curl -i \
      -u <mmcbride>:<SecurePwd!!>
      -H "Content-Type: application/json" \
  4. Save your changes to the shell files, if required.
  5. Open the xmatters-plugin.config file in a text editor.
  6. On the XM_INTEGRATION_URL line replace <YOUR_HOST_TRIGGER_URL> and <YOUR_SERVICE_TRIGGER_URL> with the URL you copied from the Icinga trigger in Flow Designer.
    object NotificationCommand "xm-host-notification" {
      command = [ SysconfDir + "/icinga2/scripts/xm-host-notification.sh" ]

      env = {
        ADDRESS = "$address$"
        HOSTDISPLAYNAME = "$host.display_name$"
        HOSTNAME = "$host.name$"
        HOSTOUTPUT = "$host.output$"
        HOSTSTATE = "$host.state$"
        HOSTSTATETYPE = "$host.state_type$"
        LASTHOSTSTATECHANGE = "$host.last_state_change$"
        NOTIFICATIONAUTHOR = "$notification.author$"
        NOTIFICATIONCOMMENT = "$notification.comment$"
        NOTIFICATIONTYPE = "$notification.type$"
        SHORTDATETIME = "$icinga.short_date_time$"
        XM_INTEGRATION_URL = <YOUR_HOST_TRIGGER_URL>
      }
    }

    object NotificationCommand "xm-service-notification" {
      command = [ SysconfDir + "/icinga2/scripts/xm-service-notification.sh" ]

      env = {
        ADDRESS = "$address$"
        HOSTNAME = "$host.name$"
        LASTSERVICESTATECHANGE = "$service.last_state_change$"
        NOTIFICATIONAUTHOR = "$notification.author$"
        NOTIFICATIONCOMMENT = "$notification.comment$"
        NOTIFICATIONTYPE = "$notification.type$"
        SERVICEDISPLAYNAME = "$service.display_name$"
        SERVICENAME = "$service.name$"
        SERVICEOUTPUT = "$service.output$"
        SERVICESTATE = "$service.state$"
        SERVICESTATETYPE = "$service.state_type$"
        SHORTDATETIME = "$icinga.short_date_time$"
        XM_INTEGRATION_URL = <YOUR_SERVICE_TRIGGER_URL>
      }
    }
  7. Add the target names of any recipients you want to notify when the notification fires.
    • For example, if you want to notify Emma Pearson, Mary McBride, and the on-call members in the Monitor Team responsible for the service, you'd add ?recipients=epearson,mmcbride,monitor%20team to the URL.
    • You must URL-encode any special characters or spaces in the target names.
  8. Save the file.
  9. Move the xmatters-plugin.config file to your Icinga config file folder. For example: /etc/icinga/conf.d.
  10. Optional: If you have any other Icinga notification attributes, you can add them to the env part of the xmatters-plugin.conf file. You must then update the cURL commands in the shell scripts for each host/service to match.

Now add the notification to any Icinga host you want to monitor.

  1. Go to the location of your Icinga hosts. For example: /etc/icinga2/conf.d/hosts.conf.
  2. Add the following code to each host.
    Copy
    vars.notification["xm"] = {
      groups = [ "icingaadmins" ]
    }
  3. Restart your Icinga service so all changes are captured and applied.

You're ready to use the webhook to trigger automated flows, including steps such as sending alerts and initiating incidents, though we always recommend testing before putting things into use.

Outputs