The Zenoss integration plugin utilizes the full capabilities of Jira Service Management and provides bi-directional integration with Zenoss. The integration leverages Jira Service Management’s Zenoss-specific executable and JEC utility to create alerts automatically and synchronizes alert status between Zenoss and Jira Service Management.
The following steps describe integrating Jira Service Management and Zenoss using the Jira Service Management Zenoss integration plugin. Note that slight alteration to these instructions may be necessary depending on the exact Linux distribution and your Zenoss configuration.
The installation packages support the following systems:
RedHat-based Linux distributions
Debian-based Linux distributions
Jira Edge Connector (abbreviated as JEC) is a prerequisite for configuring the outgoing authentication of Zenoss integration. You can combinedly use JEC and Zenoss scripts to update alerts on Zenoss. With this setup, you can deploy your own script, modify the ones provided, or run customized actions on Zenoss. Download the latest version of the Zenoss package from this repository.
Run the following command:
Before rpm upgrades, back up your configuration files. The rpm package does not overwrite the existing configuration during upgrades. It saves the new default configuration file as integration.conf.rpmnew. To upgrade from version 201X-XX-XX to 2.X.X, add the Learn more about config file handling for rpm upgrades. |
Run the following command:
|
If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through 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 Zenoss integration in Jira Service Management:
Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Zenoss”.
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 API key.
You will use this key while configuring the integration in Zenoss later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.
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 and states if they are mandatory.
|
Configure the golang-executable file in any of the following three methods:
Configure from the |
Configure by entering flags into the command of the notification created in Zenoss, described in https://operations-help.atlassian.net/wiki/spaces/OPSHELP/pages/4259932/Integrate+with+Zenoss#Configure-triggers-in-Zenoss. Use To send additional custom arguments, add them after the flags. For example, |
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 send2jsm.go and how to build a go script in the “Source and recompiling send2jsm” section in this article. |
Select Events > Triggers from the Navigation menu.
Create a trigger named Jira Service Management.
Select Events > Triggers from the Navigation menu.
Select Notifications from the left panel.
Create a notification.
Select the notification created earlier and select Edit.
Under the "Notification" tab, enable the notification and select the "Send Clear" checkbox.
Select the trigger you created earlier from the list and select Add.
Under the "Content" tab:
Add optional -eventState=close to Clear Command. send2jsm executable does not try to get event details from Zenoss and directly closes the event's alert in Jira Service Management. /home/jsm/jec/scripts/send2jsm -evid=${evt/evid}
Under the "Subscribers" tab, select the subscribers and select SUBMIT.
This step is optional.
You can combinedly use JEC and Zenoss script to update alerts on PRTG. With this setup, you can deploy your own script, modify the ones provided, or run customized actions on PRTG. To run actions in Zenoss, JEC gets the configuration parameters from the configuration file, config.json (found at /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 running JEC documentation.
The Zenoss integration package does not support SSL v1.0. If your Zenoss server has SSL v1.0, upgrade your SSL server. |
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.
If the integration is not working, review this section and follow the prescribed guidelines.
Run the following test command from the shell and check if a test alert is created in Jira Service Management:
Setting send2jsm plugin's log level to DEBUGSet the send2jsm plugin's log level to DEBUG. Open the /home/jsm/jec/conf/integration.conf file and change the line |
Check the alert logs.
|
|
https://operations-help.atlassian.net/l/cp/LGQEmX9J