Jira

Track and resolve bugs faster by connecting errors from Sentry with Jira issues.

This integration needs to set up only once per organization, then it is available for all projects.

Install

  1. Navigate to Settings > Integrations > Jira.

jira overview

  1. Install the Sentry app through the Jira marketplace.

  2. Select which Sentry organizations you’d like to use with Jira, and Save Settings.

  3. In Sentry, you’ll see a new Jira instance appear on the Integrations page.

    jira install

Jira should now be authorized for all projects under your Sentry organization.

Jira Server

Generate an RSA public/private key pair

To generate an RSA public/private key pair, run the following commands in your terminal window one by one.

Copied
openssl genrsa -out jira_privatekey.pem 1024
openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem
  1. In Jira, click the gear icon, then Applications > Application Links.

  2. Enter the following as the application URL: https://sentry.io/extensions/jira_server/setup/

  3. Click "Create New Link". If you see a warning that “No response was received from the URL you entered,” ignore and click "Continue".

  4. In the resulting dialog, fill out the form as follows:

    Application Name Sentry
    Application Type Generic Application
    Service Provider NameSentry
    Consumer Key (your choice, but keep this handy for the next step)
    Shared Secret sentry
    Request Token URL https://sentry.io
    Access Token URLhttps://sentry.io
    Authorize URL https://sentry.io
    Create Incoming Link No
  5. Click "Continue". This will return you to the Configure Application Links page, where you'll see an application called Sentry.

  6. Click the pencil icon next to the Sentry application.

  7. On the lefthand side of the resulting modal, click "Incoming Authentication". Fill out the form as follows, and press Save:

    Consumer Key (the consumer key from Step II.4)
    Consumer Name Sentry
    Public Key(the public key you created in Section I)
    Consumer Callback URL https://sentry.io/extensions/jira_server/setup/
    Allow 2-Legged OAuth no

Connect your Jira Server application with Sentry

  1. Navigate to Organization Settings > Integrations.
  2. Next to Jira Server, click "Install".
  3. In the resulting modal, click "Add Installation".
  4. In the resulting window, enter the base URL for your Jira Server instance, your consumer key, and your private key. Click "Submit". Then, complete the OAuth process as prompted.
  5. In Sentry, you’ll see a new Jira Server instance appear on the Integrations page.

Jira should now be authorized for all projects under your Sentry organization.

Configure

Use Jira to leverage issue management, issue syncing, and receive notifications about changes to issue status.

Issue Management

Issue tracking allows you to create Jira issues from within Sentry, and link Sentry issues to existing Jira Issues.

Issue management can be configured in two ways - automatically or manually.

Automatically

To configure issue management automatically, create an Issue Alert. When selecting the action, choose Create a new Jira issue.

jira ticket rule

A Jira issue will be created automatically when the alert has been triggered.

Manually

To configure issue management manually, once you've navigated to a specific Sentry issue, you'll find the Linked Issues section on the right hand panel.

jira link issue

Here, you’ll be able to create or link Jira issues.

jira create issue

Issue Sync

Sync comments, assignees, and status updates for issues in Sentry to Jira, to minimize duplication. When you delegate an issue to an assignee or update a status on Jira, the updates will also populate in Sentry. When you resolve an issue in Sentry, the issue status will automatically update in Jira.

To configure Issue sync, navigate to Organization Settings > Integrations, and click "Configure" next to your Jira Server instance. On the following page, you’ll see options of what information you’d like synced between Sentry and Jira.

jira sync

Issue Notifications

Alert notifications in Sentry can be routed to many supported integrations, but by default are aimed at email. You will need to configure a project’s Alert Rules to properly route notifications to a specific integration.

Troubleshooting

Trouble with Self-Hosted Sentry Installation

If you're having trouble setting up Self-Hosted Sentry, verify the following:

  • The provided installation URL is a fully qualified domain name (FQDN), which is resolvable on the internet.
  • The IP addresses Sentry uses to make outbound requests are allowed.
  • Sentry's access to your installation URL is not path restricted.

"Something went wrong" Message with JIRA on SaaS sentry.io Install

jira something went wrong

This issue typically occurs if you have an ad blocker blocking the conversation between JIRA and Sentry during setup. To remediate the issue, disable your ad blocker and go through the installation flow again.

Can't Create Issues Using a Custom Required Field

We don’t support custom required fields for the Jira integration. The only required fields we support are the ones that are pre-populated by us. If possible, you can edit your required fields in Jira, or as a workaround, you can create a ticket in Jira first and then link it in Sentry.

Receiving a 4xx/5xx Error for the Jira Server Integration

A 400 error is often generated because the Jira instance is not publicly accessible. Make sure your instance is routable (that is, our server can reach it!). If not, you’ll need to put your Jira instance on the internet so that we can reach it.

For a 500 error, unfortunately the reason can vary. This error means we couldn’t connect to your server from our server. For example, perhaps your proxy is not configured correctly, or not set to allow our IP. If you need to allow our IPs, you can find a list of our IP ranges here.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").