Integrate with Nagios

Overview

Jira Service Management provides a rich bidirectional integration plugin for Nagios. Jira Service Management has a number of easy-to-use integration methods (email, API, command line tools, programming libraries, etc.) to ensure all monitoring tools are easily integrated with Jira Service Management. Nagios is integrated with Jira Service Management via the email interface, or by executing scripts in any language that uses Jira Service Management Web API. This document describes two supported integration options.

This article explains integrating Jira Service Management with Nagios. If you’re using Nagios XI, go to Integrate with Nagios XI.

What does the integration offer?

The Nagios plugin for Jira Service Management supports bidirectional integration with Nagios. The integration leverages Jira Service Management’s Nagios-specific executable and JEC utility to automatically create rich alerts (status, alert histogram, trends, etc.) and synchronizes alert status between Nagios and Jira Service Management. The Nagios plugin is the recommended integration method as it enables Nagios to take advantage of advanced capabilities provided by Jira Service Management.

How does the integration work?

When a host or service state becomes down in Nagios, an alert is created in Jira Service Management.
Upon creation of the new alert, related histogram and trends images from Nagios is attached to the alert automatically.
When the Jira Service Management alert is acknowledged, the alert in Nagios is also acknowledged automatically, and vice versa.
When a note is added to the Jira Service Management alert, the alert in Nagios is also updated automatically, and vice versa.

Set up the integration

The Nagios integration plugin utilizes the full capabilities of Jira Service Management and provides bi-directional integration with Nagios. The steps in the following procedure describe how to integrate Jira Service Management and Nagios by using the Nagios integration plugin. Note that slight alteration to these instructions may be necessary depending on the exact Linux distribution and your Nagios configuration.

Installation prerequisites

The installation packages support the following systems:

RedHat-based Linux distributions
Debian-based Linux distributions

Install the Jira Service Management plugin for Nagios

Jira Edge Connector (abbreviated as JEC) is a prerequisite for configuring the outgoing authentication of Nagios integration. You can combinedly use JEC and Nagios scripts to update alerts on Nagios. With this setup, you can deploy your own script, modify the ones provided, or run customized actions on Nagios. Download the latest version of the Nagios package from this repository.

Instructions for RedHat-based distributions

Run the following command:

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

Before rpm upgrades, back up your configuration files.

The rpm package does not overwrite the existing configuration during upgrades. It saves the new default configuration file as integration.conf.rpmnew. To upgrade from version 201X-XX-XX to 2.X.X, add the --force parameter. For example: rpm -U --force jsm-nagios-<your_version>.rpm

Learn more about config file handling for rpm upgrades.

Instructions for Debian-based distributions

Run the following command:

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

Installation

The steps below describe how to integrate Jira Service Management and Nagios using Jira Service Management Nagios integration plugin. Slightly alter these instructions depending on the exact Linux distribution and Nagios configuration.

If Lamp based Nagios plugin is being used, backup all existing configurations. Uninstall the old plugin, then install the new one.

Prerequisites

Packages provided support the following systems:

Red Hat based Linux distributions, REHL7 and above
Debian based Linux distributions, Debian 8(Jessie) and above

Installation of Nagios plugin for Jira Service Management

Download the latest version of OEC

To download the latest version of Nagios packages, please use readme file of oec-scripts repository.

For Red Hat Based Distributions

Run the following command:
```
rpm -i jsm-nagios-<your_version>.rpm
```

During upgrades, rpm package does not overwrite your existing configurations. It saves the new default configuration file as jsm-integration.conf.rpmnew. Find more information about rpm upgrade config file handling from here.

To update from version 201X-XX-XX to 2.X.X, you must add --force parameter. E.g.:

rpm -U --force opsgenie-integration-<your_version>.rpm

We suggest backing up your configuration files before update!

For Debian Based Distributions

Run the following command:
dpkg -i opsgenie-nagios-<your_version>.deb

Add Nagios integration

If you're using the Free or Standard plan in Jira Service Management. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add a Nagios integration in Jira Service Management:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Nagios”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the URL.
You will use this URL while configuring the integration in Nagios later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the Jira Service Management plugin in Nagios

The plugin uses a golang-executable file (included in the plugin as send2jsm) to create, acknowledge, and close alerts in Jira Service Management. To make send2jsm work, you need to make some configurations. The following table lists the parameters and states if they are mandatory. Setting the apiKey is required. Other configuration parameters are set to their default values that work with most Nagios implementations but may need to be modified as well.

Configuration parameters

Configuration Parameters	Description	Mandatory?	Location
apiKey	Copy the URL from the integration configuration page in Jira Service Management. send2jsm uses this key to authenticate to Jira Service Management. API key is also used to identify the right integration configuration that should be used to process alerts.	Yes	/home/jsm/jec/conf/jec-config.json
baseUrl	Change this field according to your Jira Service Management environment (For example: EU, sandbox)	No	/home/jsm/jec/conf/jec-config.json
teams	Teams that should be notified of the Nagios alerts. Use the field to set the default value. You can modify it to route alerts to different teams on the integration configuration page in Jira Service Management.	No	/home/jsm/jec/conf/integration.conf
tags	Tags of the alert that created in Jira Service Management.	No	/home/jsm/jec/conf/integration.conf
nagios_server	The Nagios server in Jira Service Management and only required when there are multiple Nagios servers. This is used by Jira Service Management when sending actions run by users (acknowledge, close, etc.) back to your Nagios servers via JEC.	No	/home/jsm/jec/conf/integration.conf
logPath	The full path to the log file. (Default: /var/log/jec/send2jsm.log)	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.enabled	To enable or disable the external proxy configuration. Default: false	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.host	Host of the proxy	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.port	Port of the proxy	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.scheme	The proxy connection protocol. It may be http or https, depending on your proxy servers. Default: http	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.username	The username for proxy authentication	No	/home/jsm/jec/conf/integration.conf
nagios2jsm.http.proxy.password	The password for proxy authentication	No	/home/jsm/jec/conf/integration.conf

Configure the golang-executable file in any of the following three methods:

Method 1: Configure from conf file

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

Method 2: Configure by using Golang flags

Configure by entering flags to command in the jsm.cfg file. Use -apiKey flag for your apiKey and -ns flag for the nagios_server name. If you don't have multiple Nagios servers, you don't have to define the Nagios server. Using flags overwrites all the other configuration methods mentioned earlier.

Configure the apiKey from the jsm.cfg file as follows (in JSON format):

define command {
    command_name    notify-host-by-jsm
    command_line    /home/jsm/jec/scripts/send2jsm -apiKey="apiKey1" -entityType=service ...
}

When apiKey is added to the cfg file, it overrides the apiKey in the integration.conf file.

To send additional custom arguments, add them after the flags. For example, customArgName1 customArgValue1 customArgName2 customArgValue2. Parse custom arguments by adding {{_payload.customArgName}} to wherever is needed in the input fields. To learn more about using raw parameters, see dynamic fields.

Method 3: Configure from script

Configure apiKey and nagios_server from the send2jsm.go script. Build the script again and put the new executable into the /home/jsm/jec/scripts directory. Learn more about the location of the send2jsm.go and how to build a go script in the “Source and recompiling send2jsm” section in this article.

Define Nagios contacts

1. Copy the /home/jsm/jec/jsm-nagios/jsm.cfg file (configures a contact, its host, and service notification commands) in to /usr/local/nagios/etc/objects directory.

Shell

cp /home/jsm/jec/jsm-nagios/jsm.cfg /usr/local/nagios/etc/objects

2. Add the following line to the main Nagios configuration file (NAGIOS_HOME/etc/nagios.cfg):

Shell

...
cfg_file=/usr/local/nagios/etc/objects/jsm.cfg
...

3. Add the contact “jsm" to the Nagios configuration’s main contact group in NAGIOS_HOME/etc/objects/contacts.cfg file. If using the default configuration contacts.cfg, add "jsm" user to the "admins" contact group.

4. Restart Nagios.

If everything goes well, alerts are seen in Jira Service Management for every notification created in Nagios.

Configure Jira Service Management to update Nagios

This is an optional step.

Select the Send Alert Actions To Nagios checkbox on the integration configuration page. You can combinedly use JEC and Nagios scripts to update alerts on Nagios. With this setup, you can deploy your own script, modify the ones provided, or run customized actions on Nagios.

To run actions in Nagios, JEC gets the configuration parameters from the configuration file, config.json (found at /home/jsm/jec/conf/jec-config.json).

Configuration parameters

alert_histogram_image_url: JEC retrieves histogram images from Nagios using this URL. Localhost should be replaced with the Nagios server address.
trends_image_url: JEC retrieves trends images from Nagios using this URL. Localhost should be replaced with the Nagios server address.
command_url: URL to update Nagios alerts when alerts get acknowledged, commented, etc.
user: Username to authenticate Nagios web server to get Nagios histogram and trends images.
password: Password to authenticate Nagios web server to get Nagios histogram and trends images.

The downloaded package includes the JEC utility (found in /usr/local/bin) and the script that JEC needs to run (found in /home/jsm/jec/scripts). Be sure to run JEC after configuring it. Learn more about running JEC documentation. If using JEC, rich alerts are populated with host or service current status information in Jira Service Management for every notification created in Nagios.

The Nagios integration package does not support SSL v1.0. If your Nagios Server has SSL v1.0, upgrade your SSL server.

Source and recompiling send2jsm

The source for the executable send2jsm is found in /usr/bin/ and send2jsm.go, in /home/jsm/jec/scripts respectively and is also available in this repository. To change the behavior of the executable, edit send2jsm.go and build it by using the following command: go build send2jsm.go

For installing go, refer to http://golang.org/doc/install. Note that the executable in the plugin is built for linux/amd64 systems.

FAQ and troubleshooting

If the integration is not working, review this section and follow the prescribed guidelines.

1. Nagios alerts are not getting created in Jira Service Management

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. Nagios is probably not notifying the Jira Service Management contact for alerts. Check your Nagios 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 Nagios” section of this article.
- 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 Nagios 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 nagios:jsm /var/log/jec
2. Check the Nagios server logs at /opt/nagios/log/zeneventd.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 nagios2jsm.logger=debug.

2. The Nagios alert is not acknowledged when the alert is acknowledged in Jira Service Management

Check the alert logs.

If "Posted [Acknowledge] action to Nagios.." is not present in the log, Jira Service Management didn't send the Acknowledge action to Nagios. Check the integration configuration, it might not have a matching the alert action.
If only the "Posted [Acknowledge] action to Nagios.." log occurs followed by no related logs, it might mean JEC is having connection problems. Check the logs.

3. Could not open Nagios RPM package

If you figure out while installing the rpm package that the package is obsolete, use rpm -i jsm-nagios-1.0.4-rpm-x86-64.rpm --nodeps instead.
If you get "is already installed" error, use rpm -i jsm-nagios-1.0.4-rpm-x86-64.rpm --force instead.

4. Permission error occurs while attaching zip file to alert in script

If you get "PermissionError: [Errno 13] Permission denied: details_*" error while running the script, prefix the path of the script to the "file_name" variable in the attach method of the script.