Integration with Atlassian Jira

Whenever Plumbr detects a new, previously unseen, error in one of the monitored applications, it can automatically create a ticket in Atlassian Jira. In order to enable this, three steps have to be done:

  • Introduce your Jira and Plumbr accounts to each other by installing and configuring the “Plumbr for Jira” app into your Jira instance
  • Configure a new alert channel on your Plumbr account
  • Mark applications or APIs which should send new errors to Jira

Installing “Plumbr for Jira” app into Jira Cloud instance

This all starts with opening Jira in your browser (See below for instructions specific to Jira Server), selecting “Settings” in the lower left corner and then selecting “Apps”:

You will get to the Atlassian Marketplace where you can find and install the “Plumbr for Jira” app

.

More information can be found in Atlassian support materials: https://confluence.atlassian.com/adminjiracloud/managing-apps-776830283.html. After installation, the “Plumbr for Jira” app will become available under the “Manage apps” menu item:

Before you can use the app, you need to configure it via the following screen:

All you need to provide is your Plumbr account ID. It can be found on the “Account Settings” page on your Plumbr SaaS or On-Premises account. After providing account id and pressing the “Save” button, you will see a confirmation message that looks like this:

Installing “Plumbr for Jira” app into Jira Server instance

For now you have to manually install Plumbr plugin into Jira Server instance. Please contact us at support@plumbr.io to obtain plugin jar file.

Open Jira Server UI in your browser and press full-stop (“.”) to open quick search dialog box in Jira. Then type “manage” and select “Manage add-ons” item:

Using “Upload add-on” link in the top right corner upload provided jar file. After installation, the “Plumbr for Jira” app will become available under the “Manage apps” menu item:

Click “Configure” button to get to the configuration screen:

All you need to provide is your Plumbr account ID. It can be found on the “Account Settings” page on your Plumbr SaaS or On-Premises account. After providing account id and pressing the “Save” button, you will see a confirmation message that looks like this:

Jira user and permissions

Plumbr for Jira Server creates an user named “plumbr” to perform its operations. It is up to you to ensure that this user has all required permissions in your Jira Server instance. At minimum it requires the following:

  • List all Jira projects
  • List types of issues available in the project that you want to connect to Plumbr
  • Create new issues in that project

Extra configuration for On-Premises Plumbr Server

For correct and secure communication between your Jira instance and Plumbr Server, they have to agree upon the location of running Plumbr Server. For that please do the following on Plumbr Server side:

  • Create a file plumbr-server/config/alert/application.properties, if does not exist yet.
  • Add a new line in that file:
    plumbr.alert.jira.connect.base-url=Plumbr Server url
    

    where Plumbr Server url has to be the same that you have configured in Jira.

Configure Jira channels

Next, log in to your Plumbr account and head to the Alert Channels page. Click on “Add new Alert Channel” and select Jira from the drop down menu

Fill in the required fields and click on “Add Channel”. You can click on the “Create a test ticket” button to verify that the channel is configured correctly and communication between your Atlassian Jira and Plumbr accounts works as expected.

Application selection

The last step is to select the applications and APIs that should alert you about new errors discovered in them. For this, select an application or API in the Plumbr Server UI, select an “Alerts” item in the left hand menu and then choose the “New Errors” tab:

Now you can select a channel for new alerts and click on “Apply” to confirm your selection.