Integrate with Icinga 2

Run the following command: 

rpm -i jsm-icinga2-<your_version>.rpm

The rpm package does not overwrite the existing configuration during upgrades. It saves the new default configuration file as integration.conf.rpmnew. Learn more about config file handling for rpm upgrades.

If you're updating the integration from version 1.., update your integration.conf file:

• Remove the icinga.alert_histogram_image_url, icinga.trends_image_url, and icinga.command_url properties.

• Add the icinga.api_url (Icinga2 API endpoint of your Icinga server) and icinga.graphite_url properties.

Run the following command: 

dpkg -i jsm-icinga2-<your_version>.deb

Run the following command:

unzip jsm-icinga2-<your_version>.zip

Configure from the /home/jsm/jec/conf/integration.conf file. This overwrites any configuration you previously made in the script.

Configure by entering flags into the command definition in the /etc/icinga2/features-available/jsm.conf file. Use -apiKey flag for your apiKey and -is flag for the icinga_server name. If there are no multiple Icinga 2 servers in use, you don't have to define the Icinga 2 server. Using flags overwrites all the other configuration methods mentioned earlier.

To send additional custom arguments define them as key-value-pairs in the argumentsdictionary. Since Icinga 2 shuffles the arguments, use the order property to make sure that the custom arguments are placed at the end of the list. Example:

"-spd" = "$service.perfdata$"

"customargument1" = {

value = "$customargument1$"

order = 1

}

Parse custom arguments by adding {{_payload.customArgName}} to the input fields as needed.
Learn more about dynamic fields.

Configure apiKey and icinga_server from send2jsm.go script. Build the script again and put the new executable in to the /home/jsm/jec/scripts directory. Find information about the location of the send2jsm.go and how to build a go script in the Source section.

Configure the golang-executable to use a proxy for sending HTTP requests by defining the HTTP_PROXY=http://host:port environment variable.

• api_url: JEC uses this URL to post alert updates to Icinga 2, such as alert acknowledgment, comments, etc. Replace the "https://localhost:5665" with the API endpoint of your Icinga 2 server.

• graphite_url (optional): JEC retrieves performance data graphs from Icinga 2 using this URL. Replace the "http://localhost:5003" with the Graphite endpoint of your Icinga 2 server.

• user: The username to authenticate to Icinga2 API

• password: The password to authenticate to Icinga 2 API.

• http.timeout: The timeout duration in milli secs to connect to Icinga 2 API.

• expire_acknowledgement_after: Removes acknowledgment after the specified duration (in minutes.) Disabled by default.

• insecure: Ignore SSL verification while accessing the API endpoint of your Icinga 2 server.

Run the following test command from the shell and check if a test alert is created in Jira Service Management: 

/home/jsm/jec/scripts/send2jsm -entityType=host -t=PROBLEM -hs=DOWN -hn=test_host

• If you get a "Trace/breakpoint trap" error, the send2jsm plugin isn't compatible with the server distribution. Rebuild send2jsm.go according to the specific server environment as described in the “Source and recompiling send2jsm” section in this article.

• If the alert is created in Jira Service Management, the integration is configured correctly. Icinga 2 is probably not notifying the Jira Service Management contact for alerts. Check your Icinga 2 alert notifications log.

• If the alert is not created in Jira Service Management, check the logs at /var/log/jec/send2jsm.log.
  Look for the following errors in the log file:

  • If you see "RestException[Could not authenticate.]" in the logs, Jira Service Management couldn't identify the API key. Check if the API key is set correctly per the steps outlined in the “Configure the Jira Service Management plugin in Icinga 2” section of this article.

  • If a "Could not execute this action with apiKey of [Icinga2] integration" error is seen in the logs, the wrong integration package may have been downloaded. Make sure the downloaded Icinga 2 integration package is correct.

  • If unsure of the problem, set the plugin's log level to debug and try again. Contact us and share the logs.

• If there is no /var/log/jec/send2jsm.log file or there are no logs in it, check the following:

  1. Check if the Icinga user has permission to write to /var/log/jec directory. The installation package should automatically do this for you. If you face issues, run the following command: 
     chown -R icinga:jsm /var/log/jec

  2. Check the Icinga 2 server logs at /var/log/icinga2/icinga2.log. See if there are error logs regarding send2jsm. Contact us with the logs as needed.

Set send2jsm plugin's log level to DEBUG

Set the send2jsm plugin's log level to DEBUG. Open the /home/jsm/jec/conf/integration.conf file and change the line send2jsm.logger=warning to icinga2jsm.logger=debug.

Check the alert logs.

• If "Posted [Acknowledge] action to Icinga 2.." is not present in the log, Jira Service Management didn't send the Acknowledge action to Icinga 2. Check the integration configuration, it might not have a matching alert action.

• If only the "Posted [Acknowledge] action to Icinga 2.." log occurs followed by no related logs, it might mean JEC is having connection problems. Check the logs.

• If you figure out while installing the rpm package that the package is obsolete, use rpm -i jsm-icinga2-1.0.4-rpm-x86-64.rpm --nodeps instead.

• If you get "is already installed" error, use rpm -i jsm-icinga2-1.0.4-rpm-x86-64.rpm --force instead.

If you're receiving an error while embedding perfData graphite into HTML, your Icinga 2 version is using perfData.png instead of perf_data.png for the graphite name. To fix the issue, update the python script as follows:

From:
        buf += """<div class="img"><img src="perf_data.png"></div>"""
To:
                buf += """<div class="img"><img src="perfData.png"></div>"""