Versions Compared

Old Version 2

changes.mady.by.user Shivi Sivasubramanian

Saved on

compared with

New Version Current

changes.mady.by.user Shivi Sivasubramanian

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The plugin uses a golang-executable file (included in the plugin as send2jsm) to create, acknowledge, and close alerts in Jira Service Management. Configure Icinga to execute this file on events to create, acknowledge, and close alerts in Jira Service Management. The following table lists the parameters and states if they are mandatory.

Expand
titleConfiguration parameters

Configuration parameter

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

responders

The default responder. This field is used to specify which responders should be notified for Icinga alerts. You can modify it to route alerts to different teams or schedules on the integration configuration page in Jira Service Management. This field is required if you haven’t set responders

...

on that page.

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

icinga_server

The Icinga server in Jira Service Management and only required when there are multiple Icinga servers. This is used by Jira Service Management when sending actions run by users (acknowledge, close, etc.) back to your Icinga servers via JEC.

No

/home/jsm/jec/conf/integration.conf

logPath

The full path of the log file (Default:  /var/log/jec/send2jsm.log)

No

/home/jsm/jec/conf/integration.conf

icinga2jsm.http.proxy.enabled

To enable or disable the external proxy configuration. Default: false

No

/home/jsm/jec/conf/integration.conf

icinga2jsm.http.proxy.host

Host of the proxy

No

/home/jsm/jec/conf/integration.conf

icinga2jsm.http.proxy.port

Port of the proxy

No

/home/jsm/jec/conf/integration.conf

icinga2jsm.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

icinga2jsm.http.proxy.username

The username for proxy authentication

No

/home/jsm/jec/conf/integration.conf

icinga2jsm.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:

...

Expand
titleMethod 2: Configure by using Golang flags

Configure by entering flags into the command of the notification created in Icinga, as described earlier in this section. Use -apiKey flag for your apiKey.

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.

Expand
titleMethod 3: Configure from script

Configure apiKey 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.

...

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

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

...

Info

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

Source for 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

...

Expand
title1. Icinga 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: 

Code Block
/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 for and recompiling send2jsm” section in this article.

  • If the alert is created in Jira Service Management, the integration is configured correctly. Icinga is probably not notifying the Jira Service Management contact for alerts. Check your Icinga 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” 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 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 server logs at /opt/icinga/log/zeneventd.log. See if there are error logs regarding send2jsm. Contact us with the logs as needed.

Setting

Set send2jsm plugin's log level to DEBUG

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

Expand
title2. The Icinga alert is not acknowledged when the alert is acknowledged in Jira Service Management

Check the alert logsthe activity log.

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

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

Learn more about activity logs.

Expand
title3. Could not open Icinga RPM package

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

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

...

Explore integration actionsAdd integration rules

https://operations-help.atlassian.net/wiki/spaces/OPSHELP/pages/2097191

https://operations-help.atlassian.net/l/cp/LGQEmX9J