Versions Compared

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. To make send2jsm work, you need to make some configurations. The following table lists the parameters , their location, and states if they are mandatory.

Expand
titleConfiguration 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. It is also used to identify the right integration configuration that should be used to process alerts.

Yes 

baseUrl

Change this field according to your Jira Service Management environment (For example: EU, sandbox) 

 

zenoss.command_url

The URL to fetch detailed event data from Zenoss in send2jsm

No

 

zenoss.user

User credentials to authenticate to the Zenoss web server

No

 

zenoss.password

User credentials to authenticate to the Zenoss web server

No 

responders

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

No

 

tags

The tags of the alert created in Jira Service Management

No

 

logPath

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

No

 

zenoss2jsm.http.proxy.enabled

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

No 

zenoss2jsm.http.proxy.host

Host of the proxy

No

 

zenoss2jsm.http.proxy.port

Port of the proxy

No

 

zenoss2jsm.http.proxy.scheme

The proxy connection protocol. It may be http or https, depending on your proxy servers. Default: http

No 

zenoss2jsm.http.proxy.username

The username for proxy authentication

No

 

zenoss2jsm.http.proxy.password

The password for proxy authentication

No

 

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

...

Expand
titleMethod 3: Configure from script

Configure apiKey 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 zenoss2jsmsend2jsm.go and how to build a go script in https://operations-help.atlassian.net/wiki/spaces/OPSHELP/pages/4259932/Integrate+with+Zenoss#Source-for-send2jsm-and-recompilingthe “Source for and recompiling send2jsm” section in this article.

Configure triggers in Zenoss

...

Configure Jira Service Management to update Zenoss

This step is optional.

You can combinedly use Use JEC and Zenoss the script to update alerts on PRTG. With this setup, you can deploy your own script, Zenoss. This enables deployment of your own scripts/ability to modify the ones provided , or run and execute customized actions on PRTGZenoss. To run execute actions in Zenoss, JEC gets the configuration parameters from the configuration file , config.json (found at /home/jsm/jec/conf/jec-config.json).

Expand
titleConfiguration parameters

Configuration parameters

 Description

Location

command_url

URL to update Zenoss events when alerts get acknowledged, closed, etc.

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

user

User credentials to authenticate on the Zenoss web server

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

password

User credentials to authenticate on the Zenoss web server

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

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 about running JEC documentation.

Info

The Zenoss integration package does not support SSL v1.0. If your Zenoss 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

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

FAQ and troubleshooting

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

Expand
title1. Zenoss 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 -test

  • 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. Zenoss is probably not notifying the Jira Service Management contact for alerts. Check your Zenoss 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 there is no /var/log/jec/send2jsm.log file or there are no logs in it, check the following:

    1. Check if the Zenoss 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 zenoss:jsm /var/log/jec

    2. Check the Zenoss server logs at /opt/zenoss/log/zeneventd.log. See if there are error logs regarding send2jsm. Contact us with the logs as needed.

...

Setting 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 zenoss2jsm.logger=debug.

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

Check the alert logs.

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

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

Expand
title3. Could not open Zenoss RPM package
  • If you figure out while installing the rpm package that the package is obsolete, use rpm -i jsm-zenoss-1.0.4-rpm-x86-64.rpm --nodeps instead.

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

...

See also

Explore integration types

...