Versions Compared

Key

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

...

Expand
titleConfiguration parameters

Configuration Parametersparameters

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 were created in Jira Service Management.

No

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

nagios_server

The Nagios server in Jira Service Management is only required when multiple Nagios servers exist. 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

...

Expand
titleMethod 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):

Code Block
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.

Expand
titleMethod 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.

...

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

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 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 if 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.conffile and change the line send2jsm.logger=warning to nagios2jsm.logger=debug.

Expand
title2. 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.

...

Explore integration actionsAdd integration rules

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