Integrate with LibreNMS

This article highlights a new alerting feature that's natively available in Jira Service Management which is gradually rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

What does the integration offer?

Using Jira Service Management LibreNMS integration, LibreNMS forwards alerts to Jira Service Management with detailed information. Jira Service Management acts as a dispatcher for LibreNMS alerts, 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 an alert is triggered in LibreNMS, the alert is created in Jira Service Management.
When the alert is acknowledged in LibreNMS, the alert is acknowledged in Jira Service Management.
When the alert is closed in LibreNMS, it closes the alert in Jira Service Management.
If Send Alert Updates Back to LibreNMS is enabled, actions for LibreNMS are executed in LibreNMS when the chosen action is executed in Jira Service Management for alerts which are created by the LibreNMS integration. (Optional)

Set up the integration

LibreNMS is a bidirectional integration. Setting it up involves the following steps:

Add a LibreNMS integration in Jira Service Management
Configure the integration in LibreNMS

Add a LibreNMS integration

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

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 LibreNMS integration in Jira Service Management, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “LibreNMS”.
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 integration URL.
You will use this URL while configuring the integration in LibreNMS later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Configure the integration in LibreNMS

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

Open Global Settings from the gear icon on the top menu in LibreNMS.
Select the Alerting Settings tab.
Find "Jira Service Management" from the list and expand it by selecting on the arrow.
Paste the Webhook URL into the "Jira Service Management URL" field.

Optional: Integrate via JEC

Use Jira Edge Connector (JEC) and the LibreNMS script to update alerts on LibreNMS. This enables the deployment of your own scripts/ability to modify the ones provided and execute customized actions on LibreNMS. To use the LibreNMS integration package, complete the steps outlined in the following sections:

Download the latest version of the LibreNMS plugin package. Find how to download and install the plugin.

Installation

For RedHat-based distributions

Run following command:

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

If while installing the rpm package you get an error saying that the package is obsolete, use rpm -i jsm-librenms-<your_version>.rpm --nodeps instead. If you get "is already installed" error, use rpm -i jsm-librenms-<your_version>.rpm --force instead.

For Debian-based distributions

Run the following command :

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

For Windows

Unzip the integration zip file which contains JEC package into a directory (C:\jsm\jec is the preferred path). Read more about running JEC.

Configure the integration for JEC

To use the JEC utility, select Authenticate with Jira Edge Connector only. Other configurations regarding LibreNMS can be done either via integration page or JEC configuration file config.json. The configuration via the integration page precedes the configuration file.

Configuration parameters

All of the following fields are mandatory to fill.

apiKey: Copy the API key from the LibreNMS integration URL copied previously.
url: Your LibreNMS server URL.
apiToken: Your LibreNMS server API token.

The package that you downloaded also includes JEC utility which is located under /usr/local/bin and the script that is needed to be run by JEC which is under /home/jsm/jec/scripts. After the configuration of JEC is done, you need to run it. Read more about running JEC.

Sample parameters sent to JEC

JSON

{
  "type": "libreNMS",
  "alertId": "f3b3475f-3859-4bd1-b472-ab339ea1e61d",
  "customerId": "4a644594-240d-4a51-ab88-0171ed29c0ce",
  "action": "Acknowledge",
  "mappedActionV2": {
    "name": "ackAlert",
    "extraField": ""
  },
  "integrationId": "1334572c-f412-428c-9ab1-607f8313fba3",
  "integrationName": "LibreNMS",
  "integrationType": "LibreNMS",
  "sendViaJEC": true,
  "alertFlowContext": {
    "requestId": "9eb36837-e601-12da-92ba-8fe3224230ad",
    "traceId": "9eb36837-e601-12da-92ba-8fe3224230ad",
    "content": {
      "alertId": "f3b3475f-3859-4bd1-b472-ab339ea1e61d"
    }
  },
  "url": "",
  "apiToken": "",
  "rule": "%macros.device_up = \"1\" && %processors.processor_usage >= \"1\""
}

Was this helpful?

It wasn't accurate

It wasn't clear

It wasn't relevant

Still need help?

The Atlassian Community is here for you.

Ask the Community