JIRA plugin
This plugin
collects ticket data from your JIRA core, software and service desk instances.
Get data for ongoing and historical JIRA tickets into TrueSight Intelligence as events. Use the historical data for retrospective analysis and understand key trends and patterns in your JIRA tickets. Use event clustering to perform advanced analytics. Configure multiple instances to collect data from multiple JIRA instances with independent polling intervals.
This topic describes the procedure to get JIRA data into TrueSight Intelligence. Some of the salient features are:
- JIRA tickets are available in the form of events in TrueSight Intelligence.
- A TrueSight Intelligence App is created using the app_id specified as part of the properties in the eventDefinition section of the json template.
- Use the Events feature to filter and view tickets for a specific time period. For more information, see Viewing-abnormality-and-MVGD-events.
- Use the event clustering feature to cluster the tickets based on predefined parameters. For more information, see Clustering-event-data-for-advanced-analysis.
Prerequisites
Meter 4.7.0-852 or later must be installed.
Java 1.8 must be installed
The JIRA plugin supports the following Operating Systems.
Linux | ✅️ |
Windows | ✅️ |
OS X | ✅️ |
Before you begin
Make sure that the field names do not contain any special characters (only _ is allowed). A system validation will prevent ingestion from progressing if the field names contain special characters.
To ingest historical JIRA data
If you want to ingest historical JIRA data into TrueSight Intelligence, it is recommended that you ingest the historical data before configuring this plugin for data collection.
Use the JIRA bulk ingestion script to get historical JIRA tickets. Based on the configuration details provided in the template, this script reads the tickets, converts them into TrueSight Intelligence events, and ingests these events into TrueSight Intelligence.
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click
> Data Collection, select the TrueSight meter, and select the Sources tab. - Click > Configure Sources.
- Click
- Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
Click + Install to start the installation.
Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.
Configuration details
Field | Description |
|---|---|
App ID | The App ID using which the events will be tagged. If the App does not exist, a new App is created. |
Source | The source name that will be used by all tickets that are available as events. For instance, an indicator for the JIRA instance to which you are connecting. |
Host Name | The host name of the JIRA server |
Port | The port used by the JIRA server |
Username | The username used to access the JIRA server |
Password | The password used to access the JIRA server |
Protocol Type | The protocol used to access the JIRA server. HTTP and HTTPS are supported. |
Field Mapping | The fields for which the information will be collected. Use the filter code block to specify the JIRA fields and values that you want to send to TrueSight Intelligence. For example, "status": ["Open"] and "priority": ["Important"] will only get Open JIRA tickets with the priority set to Important. For more information, see the Templatesection. |
Poll Interval | Frequency (in minutes) used to poll for collecting the tickets |
Template
By default, the out-of-the-box "filter" configuration will only get JIRA tickets with status set to Closed, Open, and Resolved. Change the default filter for the status and set filter for other fields as required.
For example, if you want to get Closed and Resolved tickets for a project named TrueSight Intelligence, use the following:
"filter": {
"status": ["Closed","Resolved"],
"config": {
"jiraHostName": "<hostName>",
"jiraPort": "",
"jiraUserName": "<userName>",
"jiraPassword": "<password>",
"tsiEventEndpoint": "https://api.truesight.bmc.com/v1/events",
"tsiApiToken": "<Input TSI Api Token>",
"retryConfig": 3,
"waitMsBeforeRetry": 5000,
"protocalType": "http",
"startDateTime": "2005-02-06 00:00",
"endDateTime": "2017-08-07 00:00"
},
"filter": {
"status": ["Closed", "Open", "Resolved"],
"issueType": [],
"priority": []
},
"eventDefinition": {
"title": "@SUMMARY",
"fingerprintFields": [
"key"
],
"severity": "@SEVERITY",
"status": "@STATUS",
"properties": {
"key": "@KEY",
"Assignee": "@ASSIGNEE",
"Priority": "@PRIORITY",
"Summary": "@SUMMARY",
"IssueType": "@ISSUE_TYPE",
"Creator": "@CREATOR",
"LastModifiedDate": "@LAST_MOD_DATE",
"Duedate": "@DUE_DATE",
"Resolution": "@RESOLUTION",
"Resolutiondate": "@RESOLUTION_DATE",
"Description": "@DESCRIPTION",
"LastViewedDate": "@LASTVIEWEDDATE",
"ProjectName": "@PROJECTNAME",
"IssueCreatedDate":"@CREATED_AT",
"app_id": "JiraIntelligenceIntegration"
},
"createdAt": "@CREATED_AT",
"eventClass": "@ISSUE_TYPE",
"source": {
"name": "Jira",
"type": "Jira",
"ref": "Jira"
},
"sender": {
"name": "Jira",
"type": "Jira",
"ref": "Jira"
}
},
"@KEY": {
"fieldId": "key"
},
"@SUMMARY": {
"fieldId": "summary"
},
"@ASSIGNEE": {
"fieldId": "assignee"
},
"@CREATED_AT": {
"fieldId": "created"
},
"@CREATOR": {
"fieldId": "creator"
},
"@LAST_MOD_DATE": {
"fieldId": "updated"
},
"@DUE_DATE": {
"fieldId": "duedate"
},
"@ISSUE_TYPE": {
"fieldId": "issuetype"
},
"@RESOLUTION": {
"fieldId": "resolution"
},
"@RESOLUTION_DATE": {
"fieldId": "resolutiondate"
},
"@DESCRIPTION": {
"fieldId": "description"
},
"@LASTVIEWEDDATE": {
"fieldId": "lastViewed"
},
"@SEVERITY": {
"fieldId": "urgency"
},
"@PRIORITY": {
"fieldId": "priority"
},
"@STATUS": {
"fieldId": "status"
},
"@PROJECTNAME": {
"fieldId": "project"
}
}
Plugin metrics
This plugin does not collect metric data. JIRA tickets are made available as TrueSight Intelligence events.