DocsAPI ReferenceRelease Notes
Docs
BigPanda AppRequest DemoBigPanda UniversityBigPanda Community

Jenkins

Send change data from Jenkins to suggest potential root cause for BigPanda incidents.

Suggest Edits
Supported VersionsTypeAuthentication Type
1.546 - 2.375.1Native PluginUser API Key

The BigPanda-Jenkins global notifier hooks into the Jenkins build process, triggering the Jenkins instance on every build. Once the build starts, the active change is sent to BigPanda and becomes available for correlation with incidents. When the build is finished, the change data in BigPanda is updated to reflect the completed change.

Key Features

  • Notifies BigPanda about Jenkins builds, capturing Shadow Changes from your CI.
  • Intelligently correlates system changes from Jenkins with high-level incidents in BigPanda to expedite the Root Cause Analysis (RCA) process and reduce Mean Time To Repair (MTTR).
  • Tracks build progress, keeping the change information in BigPanda up to date.

Standard Jenkins Data Model

BigPanda converts and organizes build information from Jenkins into tags.

Below are the methods being leveraged to populate the needed Changes tags

MethodChange TagDescription
getFullDisplayName() + getStartTimeInMillis()identifierThe unique identifier for the change.
getStartTimeInMillis()startThe build start time. This is transformed into seconds prior to being sent to BigPanda.
getFullDisplayName()summaryThe full name of the build.
getDurantion()endThe build end time calculated against the start time.
getCauses()causesA potential array of build triggers.
getDescription()description(Optional) This tag is populated if a description of the build is provided.

📘

Extra tags

Tags such as causes and description are added to the tags property within the Change Object.

Install the Integration

Before You Integrate

Before installing the Jenkins integration, ensure that you have done the following:

  • Obtain admin access to Jenkins
  • Create a BigPanda API Key and save the key
  • Create a Jenkins Integration. and save the app key

❗️

Endpoint URL

The endpoint URL field in the configuration has a default endpoint that makes sure the data reached the BigPanda console. Consult with BigPanda before updating this field for a custom solution.

Create an App Key

Create an app key in BigPanda.

👍

Integration Specific

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

App Key Configuration in BigPanda

App Key Configuration in BigPanda

Create a BigPanda API Key

  1. Follow the API Keys Management instructions on generating an API Key.
  2. Note the API Key for use later in the setup

Install & Configure the BigPanda Plugin

  1. In your Jenkin’s instance, navigate to Manage Jenkins > Manage Plugins.

  2. Click the Available plugins tab and search for the BigPanda Notifier plugin.

  3. Install the BigPanda Notifier plugin, waiting for Jenkins to restart if necessary.

  4. Once the install has finished, navigate to Manage Jenkins > Configure System.

  5. In the Global BigPanda Notifications settings, enable Advanced features.

  6. Provide the following values for the BigPanda API Key, BigPanda App Key and Endpoint URL:

    • BigPanda API Key: API Key Created Earlier
    • BigPanda App Key: <Your App Key>
    • Endpoint URL: https://integrations.bigpanda.io/jenkins/changes

  7. Click Apply and then Save

Troubleshooting

The BigPanda Notifier logs to your Jenkins build logs. If you are encountering issues you can check these logs for more details.

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.

Deactivate Inbound Integration

If you want to stop sending data to BigPanda but don’t want to delete your integration, you can temporarily deactivate it.

To deactivate an inbound integration:

  1. In BigPanda, navigate to the Integrations tab and select the desired integration from the list. This will open integration details on the right side of the window.
  2. At the top of the integration details, click the Active/Inactive toggle next to the application name to change the status of the integration.

In the integrations list, inactive integrations will be marked with a gray bar.

Stop Sending Data to BigPanda

In Jenkins, disable any settings that send data to BigPanda.

  • You can uninstall the plugin by navigating to Manage Jenkins > Manage Plugins.
  • From the Installed tab, you can select the Uninstall button for the BigPanda Notifier plugin.

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.

❗️

Data Removal

This procedure does not remove any data from the integrated system.

Updated 4 months ago