Skip to main content

Jira

The BigPanda application for Jira is a native Jira application that enables easy setup of multiple different integrations between BigPanda and Jira.

To learn more about the Jira integration, see the BigPanda for Jira BigPanda University Course.

Jira Issues - Cloud

In Jira Software Cloud, issues help you manage code, estimate workload, and keep track of your team.

Supported Versions

Type

Authentication Type

Jira Cloud

Connect App

API Key and Bearer Token

The BigPanda for Jira integration allows you to automatically create actionable Jira Issues based on high-level correlated BigPanda incidents. Jira issues are synchronized with the corresponding BigPanda alerts allowing you to continue working in Jira while benefiting from BigPanda’s tools. The integration allows you to configure parameters in Jira for the customization of each project instance.

When a BigPanda incident is shared through the Jira integration, a corresponding issue is created in Jira with details of the correlated alerts and links to the BigPanda incident. Changes occurring to the BigPanda Incident will update the corresponding Jira issue. Additionally, if changes occur to the Jira issue, then it updates the corresponding BigPanda.

Compatible Versions

The Plugin is not compatible with JIRA Service Manager.

Next-Gen projects require that all fields that are mapped within the BigPanda Jira app (Priority, Status, etc.) need to also be included in the Create Issue screen for each Issue Type.

Key Features

  • Bidirectional Logic: Configurable settings that allow resolve events for BigPanda incidents to automatically resolve a Jira issue. In addition, you can enable that incidents reopened in BigPanda can reopen a Jira issue.

  • Priority synchronization: Priority levels set for BigPanda incidents can automatically set the priority levels of corresponding Jira Issues.

  • Direct link to BigPanda incident: Links directly from the Jira issue to the BigPanda incident allowing you to view the incident details, the incident preview page, and the incident timeline. You can also view the alerts and changes occurring in the BigPanda console.

  • Field Mapping: Align certain BigPanda alert tags to the fields used by your project's issue type, whether required or optional.

  • Multi-integration: Allows you to set up an integration for each of your Jira projects.

Jira Sync and AutoShare

The JIRA integration follows standard AutoShare rules for outbound shares.

The bi-directional sync is time based, and is in addition to the outbound sharing updates. Changes in either BigPanda or Jira are synchronized within the other platform. By default, information is updated every 15 seconds reducing latency synchronization to less than 5 minutes. As a result, you are provided with an up-to-date view of incidents at real-time.

See Manage AutoShare for more information.

Install the Integration

Install the integration by following these steps:

Create an App Key

Create an app key in BigPanda.

Integration specific

You'll need a separate app key for each integrated system.

https://files.readme.io/9865f2f-Integrations_App_Key_Creation.jpg

App Key Configuration in BigPanda

Create a BigPanda API Key

  1. Generate an API Key

  2. Note the API Key for use later in the setup

Configure the Integration Webhook

  1. Set the value of the x-bp-api-key header below to the API Key you created in the previous step

  2. Click Configure Webhook

Integrations_Webhook_Builder_Simple.jpg

Install the BigPanda App in Jira

Install the BigPanda Jira Application from the Atlassian Marketplace

  1. In Jira navigate to Settings > Find new apps

  2. Search for BigPanda

  3. Click the BigPanda application

  4. Click the yellow Get app button

  5. Click Get it now to install the BigPanda Jira application

The install may take some time. Wait to move to the next step until the installation is complete.

Connect Jira to BigPanda

  1. In Jira from the top bar navigate to Apps > BigPanda

  2. Fill in the Access Token and API Key fields:

    • Access Token: <Your Org Bearer Token>

    • API Key: API Key Created Earlier

  3. Click Save

Basic Configuration of the Jira Integration

  1. From the BigPanda app configuration select Projects

  2. Click Add Project to connect a Jira Project to this integration. The Project Configuration form should appear.

  3. Fill in the App Key field:

    • App Key: <Your App Key>

  4. Select the Jira Project you wish to connect to this integration

  5. Select the Jira Issue Type you wish to use for issues created by this BigPanda integration

  6. Configure the Bi-Directional Logic

    • Auto Resolve BigPanda Incident: Toggle on if resolving a Jira Issue should also resolve the connected incident in BigPanda

    • Auto Resolve Jira Issues: Toggle on if resolving a BigPanda incident should also resolve the connected Jira Issue

    • Auto Re-Open Jira Issues: BigPanda incidents will automatically reopen if alerts are triggered within a short window. Toggle on if the connected Jira Issue should reopen. Toggle off for the reopened BigPanda incident to create a new Jira Issue.

    • Re-Open Window (min): If Auto Re-Open is toggled on select the time frame that a closed alert should reopen the Jira Issue.

  7. Configure the Status Mapping behavior, defining which Jira issue status to use for creation and update events.

  8. Configure the Priority Mapping behavior, selecting the default Jira issue priority as well as what Jira issue priority to use for each BigPanda priority

  9. Click Save to save your changes

After saving, any BigPanda incidents that are shared to this integration will create corresponding issues in Jira.

Advanced Configuration and Customization

The fields on the configuration page can be updated and customized to reflect your unique needs.

Jira Field Customization

In Field Mapping, you can define the BigPanda Incident Tags that will map to different required or optional fields for a specific Project/Issue Type. In addition to the field name, you will need to define the data type that each field has in JIRA: (Boolean, Integer, String, Array of Strings, or Array of Integers).

In Issue Summary, you can define a description template for a Jira issue. By default, BigPanda provides the following template:

h2. {{priority}} | {{status}}
*Environment:* {{env_name}} {{env_id}}

[Incident Link|{{incident_link}}]

----

h2. {{active_alert_count}} Active Alert(s) ({{alert_count}} Total)
(x) {{critical_count}} Critical | (!) {{warning_count}} Warning | (/) {{ok_count}} Resolved
                                                                   
{{alerts_table}}

However, you can customize the way the BigPanda incident information is presented in the Jira issue by using the Jira Markup Syntax For more information, see the Jira documentation.

The below parameterized fields available for customization are:

Jira Description Field

Description

{{priority}}

Priority tag from BigPanda

{{status}}

The incidents

{{start_time}}

Time of when the incident started in BigPanda

{{incident_link}}

Link that points back to the incident in BigPanda

{{env_name}}

The name of the environment from BigPanda

See Environments

{{env_id}}

The id of the environment

{{alert_count}}

Total number of alerts in the incident in BigPanda

{{active_alert_count}}

Number of alerts either in a critical or warning state in the incident in BigPanda

{{critical_count}}

Number of critical alerts in the BigPanda incident

{{warning_count}}

Number of warning alerts in the BigPanda incident

{{ok_count}}

Number of resolved alerts in the BigPanda incident

{{acknowledged_count}}

Number of acknowledged alerts in the BigPanda incident

{{unknown_count}}

Number of unknown alerts in the BigPanda incident

{{alerts_table}}

The list of alerts from the BigPanda Incident

View the Jira Issue Workflow

Select the Jira Issue from the list of your projects to open the Issue Glance dialog box.

The issue summary appears in the description field in the left pane.

The issue glance appears in the right pane. The glance provides a quick overview of information relating to an issue, including the BigPanda incident and its priority status.

jira_issueworkflow

Example of a Jira Issue

  1. To link to the BigPanda console, select the BigPanda Incident.

  2. Select Correlated Alerts. The Alerts tab displays a table of all BigPanda alerts associated with the Jira Issue, including the alert status and its primary and secondary properties.

  3. Select Related Changes. The Changes tab displays any changes determined to be suspect or match changes for the associated alert. A suspect change indicates a change that may be related to the current alert. A match change indicates a change determined to be related to the current alert. The table remains empty if no suspect or match changes related to the alert are found.

  4. For extra details, select any of the following links:

Parameter

Description

View Timeline

Displays the incident timeline in BigPanda.

Incident Preview

Displays the incident preview page where you can see the latest incident status without logging in to BigPanda.

View Incident

Links directly to the incident feed and displays the highlighted incident and the incident overview.

Uninstall the Integration

Deleting an integration requires that you remove the integration in both the integrated system and BigPanda. We recommend that you first uninstall the integration on the integrated system to prevent traffic from being sent and rejected by BigPanda, since the app_key will not exist once you delete the integration in BigPanda.

Caution during replacement

When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.

Disable the Integration

You can stop sending change data to BigPanda but preserve your configuration settings by disabling the integration in ServiceNow.

  1. In the ServiceNow application, navigate to BigPanda > Configuration.

  2. In the Incidents, Alert Processing - Add On, or Maintenance Plan section, de-select the Active checkbox

  3. Save the configuration

Stop Sending Data from BigPanda

In BigPanda, disable any settings that send data to the integrated system. This includes modifying or removing AutoShare rules or Environments that are tied to the integration.

Stop Sending Data to BigPanda

Uninstall the Jira Cloud app:

  • Uninstall the app by navigating to Jira Settings > Apps > Manage apps.

  • Use the Uninstall button for the BigPanda App.

Uninstall the Jira Server app:

  • Uninstall the app by navigating to Jira Settings > System > Webhook.

  • Select the BigPanda webhook and click on the delete button.

Delete the Integration in BigPanda

Take the following steps to delete the integration from BigPanda:

  1. In BigPanda, navigate to the Integrations tab and select the desired integration from the list.

  2. In the integration details on the right of the page, click the trash icon, then confirm you want to delete the integration. The integration will be removed immediately.

No Data Removal

This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.

Jira Changes

The BigPanda Jira app creates a Jira webhook that sends BigPanda all new and updated issues matching the customer-provided JQL filter. The change data is processed and normalized according to the configuration provided in the BigPanda Jira app. The prepared change record is then sent to the BigPanda Console.

Once in the console, these changes are available for use in the RCA process with BigPanda's Root Cause Changes feature.

Supported Versions

Type

Authentication Type

Jira Cloud or

Jira Server

Native App or

Webhook

API Key and Bearer Token

Key Features

  • Native app to easily integrate BigPanda with Jira.

  • JQL filters to target your projects and issues for change management.

  • Easy configuration via the configuration form located in the BigPanda Jira app, where you can:

    • Map custom statuses in Jira to BigPanda statuses.

    • Map custom fields in Jira to BigPanda tags.

    • Hide any undesired fields from the BigPanda UI.

Data Models

BigPanda converts and organizes Jira issue information into tags.

Default Field Mapping

BigPanda Tag

Jira Field

Description

identifier

key

The unique identifier for the change.

status

status.name

The change status.

start

created

When the change started.

summary

summary

Summary of the change.

end

resolutiondate

When the change ended.

The mapping between Jira fields and BigPanda tags can be customized in the app configuration.

Default Status Mapping

BigPanda Status

Jira Statuses

Description

Planned

[none]

A change has been planned but is not yet in progress.

In Progress

open, reopen, in progress

A change is currently in progress.

Done

resolved, done, closed

A change was resolved.

Canceled

[none]

A change was cancelled or aborted.

The mapping between Jira and BigPanda statuses can be customized in the app configuration.

Install the Integration

Install the integration by following these steps:

Create an App Key

Create an app key in BigPanda.

Integration specific

You'll need a separate app key for each integrated system.

https://files.readme.io/9865f2f-Integrations_App_Key_Creation.jpg

App Key Configuration in BigPanda

Create a BigPanda API Key

  1. Generate an API Key

  2. Note the API Key for use later in the setup

Install & Configure the BigPanda App

  1. In your Jira instance, navigate to Jira Settings > Apps > Find new apps

  2. Search for and install BigPanda App

  3. Go to Jira Settings > Apps > Manage apps

  4. Select the BigPanda App and click on Configure

  5. Fill in the API Key and App Key fields with the following values:

    • API Key: API Key Created Earlier

    • App Key: <Your App Key>

Advanced Configuration

The default configuration uses a fixed set of Jira fields for creating a change in BigPanda. Generally you will want to customize which Jira fields are used when creating change records in BigPanda.

The additional fields on the configuration page can be updated to reflect your unique environment needs.

Uninstall the Integration

Deleting an integration requires that you remove the integration in both the integrated system and BigPanda. We recommend that you first uninstall the integration on the integrated system to prevent traffic from being sent and rejected by BigPanda, since the app_key will not exist once you delete the integration in BigPanda.

Caution during replacement

When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.

Disable the Integration

You can stop sending change data to BigPanda but preserve your configuration settings by disabling the integration in ServiceNow.

  1. In the ServiceNow application, navigate to BigPanda > Configuration.

  2. In the Incidents, Alert Processing - Add On, or Maintenance Plan section, de-select the Active checkbox

  3. Save the configuration

Stop Sending Data from BigPanda

In BigPanda, disable any settings that send data to the integrated system. This includes modifying or removing AutoShare rules or Environments that are tied to the integration.

Stop Sending Data to BigPanda

Uninstall the Jira Cloud app:

  • Uninstall the app by navigating to Jira Settings > Apps > Manage apps.

  • Use the Uninstall button for the BigPanda App.

Uninstall the Jira Server app:

  • Uninstall the app by navigating to Jira Settings > System > Webhook.

  • Select the BigPanda webhook and click on the delete button.

Delete the Integration in BigPanda

Take the following steps to delete the integration from BigPanda:

  1. In BigPanda, navigate to the Integrations tab and select the desired integration from the list.

  2. In the integration details on the right of the page, click the trash icon, then confirm you want to delete the integration. The integration will be removed immediately.

No Data Removal

This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.

In this section: