Jira
Learn more about Sentry's Jira integration and how it can help track and resolve bugs faster by connecting errors from Sentry with Jira issues.
Sentry owner, manager, or admin permissions, and Jira admin permissions are required to install this integration. This includes the following permissions: read, write, act_as_user, and access_email_addresses.
- Navigate to Settings > Integrations > Jira.
Install the Sentry app through the Jira marketplace.
If you have an ad-blocker enabled, disable it now or you won't be able to complete step number 4.
Select which Sentry organizations you’d like to use with Jira. Then click the presented link to return to Sentry.
In Sentry, you’ll see a new Jira instance appear on the Integrations page.
Jira should now be authorized for all projects under your Sentry organization.
As of February 2024, Jira has discontinued support for Jira Server. Accordingly, we have stopped maintaining the docs for this integration. The instructions below may be out of date.
Sentry's Jira Server Integration is built using Application Links and should be able to integrate with Jira Data Center as well.
To generate an RSA public/private key pair, run the following commands in your terminal window one by one.
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
In Jira, click the gear icon, then Applications > Application Links.
Enter the following as the application URL:
https://sentry.io/extensions/jira-server/setup/Click "Create New Link". If you see a warning that “No response was received from the URL you entered,” ignore and click "Continue".
In the resulting dialog, fill out the form as follows:
Application Name Sentry Application Type Generic Application Service Provider Name Sentry Consumer Key (your choice, but keep this handy for the next step) Shared Secret sentry Request Token URL https://sentry.io Access Token URL https://sentry.io Authorize URL https://sentry.io Create Incoming Link No Click "Continue". This will return you to the Configure Application Links page, where you'll see an application called Sentry.
Click the pencil icon next to the Sentry application.
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
Confirm Sentry's IP ranges are allowed.
- Navigate to Organization Settings > Integrations.
- Next to Jira Server, click "Install".
- In the resulting modal, click "Add Installation".
- 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.
- 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.
Use Jira to leverage issue management, issue syncing, and receive notifications about changes to issue status. Additionally, add ignored fields to hide specified fields in the issue creation form.
Issue tracking allows you to create Jira issues from within Sentry, and link Sentry issues to existing Jira Issues.
Note
Manual issue management is available to organizations on Team, Business, and Enterprise plans.
Automatic issue management is available to organizations that include transactions in their Business and Enterprise plans.
Issue management can be configured in two ways - automatically or manually.
To configure issue management automatically, create an Issue Alert. When selecting the action, choose Create a new Jira issue.
A Jira issue will be created automatically when the alert has been triggered.
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.
Here, you’ll be able to create or link Jira issues.
To minimize duplication in issue tracking, you can sync comments, assignees, and status updates for Sentry issues to Jira tickets and vice versa. 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. When Jira tickets are marked Done, you can configure how the corresponding issue in Sentry should be resolved.
Note
Issue sync is available for organizations on the Team, Business, and Enterprise plans.
To configure Issue sync, navigate to Organization Settings > Integrations, and click "Configure" next to your Jira Server instance. On the following page, you can configure how you want information to sync between Sentry and Jira.
Note
If you hit a 4xx or 5xx error during or after setting up the Jira Server integration, see this troubleshooting section.
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.
Ignored fields are Jira fields that are hidden in the issue creation form. To add ignored fields, navigate to Settings > Integrations and click "Configure" next to your Jira instance. Then scroll down to “Ignored Fields” and enter a comma separated list of the Jira field IDs.
Field IDs are different from the labels on the issue creation form. If you need help finding a field's ID, check out the Atlassian docs here.
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.
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.
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.
This problem occurs when you've selected a priority option for the alert that doesn't exist for the given project. If your project configuration contains the "Priority" field, the dropdown will show every priority from all projects. Ensure your alert's saved priority is available on your chosen project.
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.
Make sure the user has been added to the relevant project in Jira and has the Assignable User permission.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").