Many SolarWinds Orion users need to integrate the monitoring and alerting capabilities with task or ticket tracking systems. The recent addition of the integration to ServiceNow allowed many users to have an easy way to connect the two worlds without needing custom scripts. In a similar way, the research team at SolarWinds has written an integration with Atlassian JIRA.
Note: This integration currently relies on the "Alert Integration" feature in Orion. Ensure that is turned on for the alerts that you want to create JIRA issues for.
To gauge interest and find early bugs, we are releasing an unofficial alpha level integration for our customers who use JIRA. This integration synchronizes Orion alerts with JIRA issues. This post will describe the configuration and usage of this integration for users to try out and let us know additional features, usability, and usefulness of the software.
The integration is meant to link alerts in Orion with issues in JIRA. For example,
- A triggered alert in Orion will create a new issue in JIRA.
- Alert notes in Orion will add a comment to the JIRA issue.
- Acknowledged alerts will transition a JIRA issue to a certain state
- Alerts that reset will transition a JIRA issue to a certain state.
Step 1: Installation
Download the bits attached to this post.
Set up the service - install the service on your main Orion server.
Step 2: JIRA Integration Configuration
Next open the file settings.json from the installation directory with a text editor like Notepad.
Update the following fields with the correct information.
Orion Settings
| Setting | Description |
|---|---|
| OrionHost | Hostname of your Orion server |
| OrionUsername | Username of the Orion user you wish to access the Orion Information Service with. This must be an admin account in order to configure the alert notifications. |
| OrionPassword | Password for the user above |
| WebhookListenUrl | The url that JIRA will call back when an event occurs in JIRA. The port in this field will need to be accessible through the firewall so that the JIRA events will be able to communicate back to the Orion JIRA Integration service |
JIRA Settings
| Setting | Description |
|---|---|
| ServerHost | Hostname for your JIRA server |
| ServerPort | Port your JIRA server is listening on |
| UseHttps | Whether the JIRA server is configured to for HTTPS |
| ProjectKey | Project key in JIRA that you want the issues opened in. |
| IssueTypeKey | JIRA issue type you would like the Orion JIRA Integration to create issues as. This field is one of the predetermined list of options available in JIRA like "Story", "Task", etc.
|
| Username | JIRA username you want to use to connect to the JIRA server |
| Password | Password for the above username |
| AcknowledgedTransitionAction | Name of the transition to set the issue to when an alert is acknowledged in Orion. Set to an empty string if not used. |
| ResetTransitionAction | Name of the transition to set the issue to when the alert is reset. Set to an empty string if not used |
| EventsToListenFor | This field is mainly for development use so do not adjust this field |
| FieldAssignment | Specify the mapping of Orion user properties to Jira custom fields. The Orion properties must be added under the "Alert Integration" section of the Alert Summery page. A sample definition would be "FieldAssignment" : { "JiraField1" : "IP Address", "JiraField2" : "Caption" } |
Sample settings file
{
"OrionHost": "orion.foo.local",
"OrionUsername": "Test",
"OrionPassword": "test",
"WebhookListenUrlRoot": "">http://localhost:8080",
"Jira" : {
"ServerHost" : "jira-01.foo.local",
"ServerPort" : "8080",
"UseHttps": false,
"ProjectKey" : "ITX",
"IssueTypeKey": "Task",
"Username": "JiraUser",
"Password": "JiraPass",
"AcknowledgedTransitionAction" : "",
"ResetTransitionAction" : "Done",
"EventsToListenFor": [],
"FieldAssignment": {},
}
}Restart the Orion JIRA Integration windows service after updating the configuration file.
Step 3: Orion Alert Configuration
Currently, the integration relies on the "Alert Integration" feature in Orion. Edit each alert you want to create JIRA tickets for and make sure the alert is enabled and the "Alert Integration" checkbox is checked. To do so
- Navigate to the "Manage Alerts" from the admin area and edit the alert
- Ensure the the alert is "Enabled"
- Navigate to the summary page by clicking the "summary" tab
- Expand the "Alert Integration" section and ensure that "Integrate alert with other SolarWinds products and subscribers" is checked.
- Click the submit button.
Step 4: Test the integration
Trigger a test alert in Orion and confirm that the desired task is created in JIRA.
See the issue in JIRA
Update the alert notes. Confirm that alert notes you add in Orion get entered as a comment in the JIRA task.
See the notes as comments in the JIRA task.
Test complete! Congratulations, you have now just used the SolarWinds Orion JIRA Integration.
Step 5: Enjoy and give feedback
Thank you for using this alpha stage integration and please let us know by responding to this post any additional requests you have for this sort of alerting integration. Also, since this is not an official release, you can not call SolarWinds support and get support for this feature. Support will be provided through this post from the research team at SolarWinds. If things are not functioning well, please stop the Orion JIRA Integration windows service and set the service to be disabled so that it does not restart on reboot.
Thanks
SolarWinds Architecture Research and Innovation Team
Message was edited by: Zeid Derhally Updated attachment to provide more logging.
Message was edited by: Zeid Derhally Updated to include information about the Field Assignment functionality
