Versions Compared

Key

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

...

Expand
titleConfiguration parameters

Configuration parameters

 Description

Location

apiKey

Copy the API key from the OP5 integration created. send2opsgenie 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.

/home/jsm/jec/conf/jec-config.json

baseUrl

Can change this field according to your Jira Service Management environment (for example: EU, sandbox)

/home/jsm/jec/conf/jec-config.json

responders

Responders field is used to specify which teams should be notified for the OP5 alerts. This field is used to set the default teams field value. Modify to route different alerts to different teams in integration settings.

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

tags

Tags field is used to specify the tags of the alert that created in Jira Service Management.

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

logPath

Specifies the full path of the log file. (Default value is /var/log/jec/send2jsm.log)

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

nagios2jsm.http.proxy.enabled

nagios2jsm.http.proxy.enabled field is to enable/disable external proxy configuration. The default value is false.

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

nagios2jsm.http.proxy.host

It is the host of the proxy.

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

nagios2jsm.http.proxy.port

It is the port of the proxy.

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

nagios2jsm.http.proxy.scheme

It is the proxy connection protocol. It may be http or https depending on your proxy servers. Its default value is http.

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

nagios2jsm.http.proxy.username

It is the proxy authentication username.

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

nagios2jsm.http.proxy.password

It is the proxy authentication password.

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

...

Expand

Configure by entering flags into the command in the jsm.cfg file. Use -apiKey flag for your apiKey and -ns flag for nagios_server name. If multiple OP5 servers are not in use, there is no need to define the nagios server. Using flags overwrites all the other configuration methods discussed earlier in the article.
Configure the apiKey from the cfg file as follows:

Code Block
define command {
    command_name    notify-service-by-jsm
    command_line    /home/jsm/oecjec/jsm-op5scripts/send2jsm -apiKey="apiKey1" -entityType=service ...
}

When apiKey is added to the cfg file, it overrides the apiKey in the config.json 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
titleSteps to troubleshoot

Run the following test command from the shell. Check if the test alert is created in Jira Service Management:

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

If "Trace/breakpoint trap" error occurs: It means the send2jsm plugin isn't compatible with the server distribution. Follow the "Source and Recompiling send2opsgeniesend2jsm" section on this page and rebuild send2opsgeniesend2jsm.go according to the specific server environment.

If the alert is created in Jira Service Management: It means the integration is installed correctly. The problem might be that OP5 is not notifying the Jira Service Management contact for alerts. Check the OP5 alert notifications log.

If not: Check the log files under /var/log/opsgeniejec. Look for the following errors in the log file:

  • If a "RestException[Could not authenticate.]" error appears in the logs, it means Jira Service Management couldn't identify your API your API key. Check if the API key is set correctly, as explained in "Opsgenie Configure OP5 Package Configuration in OP5 Monitor" on this page.

  • If "Could not execute this action with apiKey of [OP5] integration" appears in the logs, the wrong integration package may have been downloaded. Make sure to download the OP5 integration package.

  • If unsure of the problem, set the plugin's log level to debug, try again, and contact us and send the logs. If there is no log files under /var/log/opsgenie/ filejec file, or there are no logs in it, check the following:

  1. First, make sure the nagios user has permission to write to /var/log/opsgenie jec directory. The installation package automatically does this for you. If you encounter problems, execute chown -R nagios:opsgenie nagios:jsm /var/log/opsgeniejec.

  2. Now check the OP5 server logs under under /var/log/opsgenie/jec. See if there are error logs regarding send2opsgeniesend2jsm, and contact us with them.

Set log level of send2jsm plugin to DEBUG

Change the line send2opsgeniesend2jsm.logger=warning to nagios2opsgenieto nagios2jsm.logger = debug in /etc/opsgeniedebug in /home/jsm/jec/conf/opsgenie-integration.conf  filefile.

Configure Jira Service Management to update Zenoss

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

...