Global Integrations

These integrations are set up once per organization, and are then usable in all projects.

Issue Management

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

Once you’ve navigated to a specific issue, you’ll find the Linked Issues section on the right hand panel. Here, you’ll be able to create or link issues.

Azure DevOps

You can now use the data from your commits to Azure DevOps, formerly known as Visual Studio Team Services (VSTS), to help you find and fix bugs faster.

Configure Azure DevOps

  1. In Sentry, navigate to Organization Settings > Integrations.
  2. If you have the legacy VSTS integration installed, you’ll see a button next to Azure DevOps that says Upgrade. If you do not have the legacy VSTS integration installed, you’ll see a button that says Install.

  3. In the resulting modal, click Add Installation.

  4. An Azure DevOps install window should pop up. Select the Azure DevOps account you’d like to link with Sentry, and press Submit.


    Azure DevOps should now be enabled for all projects under your Sentry organization, but you’ll need to configure the features below.

Commit Tracking

Commit tracking allows you to hone in on problematic commits. Learn more about commit tracking.

Suspect Commits and Suggested Assignees

Once you set up commit tracking, you’ll be able to see the most recent changes to files found in the issue’s stack trace with suspect commits.

For issues where the files in the stack trace match files included in commits sent to Sentry, you’ll see the suspect commit, with a link to the commit itself.

You’ll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.

Issue Management

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

Once you’ve navigated to a specific issue, you’ll find the Linked Issues section on the right hand panel. Here, you’ll be able to create or link Azure DevOps issues.

Issue Sync

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

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

Resolve in Commit

Once you send commit data, you can start resolving issues by including fixes -SHORT-ID> in your commit messages. For example, a commit message might look like:

Prevent empty queries on users

Fixes MYAPP-317

When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit, and, later, when that commit is part of a release, we’ll mark the issue as resolved.

Troubleshooting

No accounts during installation

If you reach the account selection page during the Azure Devops installation process (step 4 in the instructions above) and see that there are no accounts available to select, please check the following possibilities:

  • Ensure you are logged into the account connected to your Azure DevOps organization.
  • Double check that your account is a Microsoft Account (MSA). At this time, we do not support Azure Active Directory (AAD) accounts.

Bitbucket

You can now use the data from your Bitbucket commits to help you find and fix bugs faster.

Configure Bitbucket

  1. In Sentry, navigate to Organization Settings > Integrations.
  2. If you have the legacy Bitbucket integration installed, you’ll see a button next to Bitbucket that says Upgrade. If you do not have the legacy Bitbucket integration installed, you’ll see a button that says Install.

  3. In the resulting modal, click Add Installation.

  4. A Bitbucket install window should pop up. Select the Bitbucket account you’d like to grant Sentry access to, and click Grant Access.
  5. On your new Bitbucket instance in Sentry, click Configure.

  6. Add any repositories from which you want to collect commit data.

Bitbucket should now be enabled for all projects under your Sentry organization.

Commit Tracking

Commit tracking allows you to hone in on problematic commits. Learn more about commit tracking.

Suspect Commits and Suggested Assignees

Once you set up commit tracking, you’ll be able to see the most recent changes to files found in the issue’s stack trace with suspect commits.

For issues where the files in the stack trace match files included in commits sent to Sentry, you’ll see the suspect commit, with a link to the commit itself.

You’ll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.

Issue Management

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

Once you’ve navigated to a specific issue, you’ll find the Linked Issues section on the right hand panel. Here, you’ll be able to create or link Bitbucket issues.

Resolving in Commit

Once you are sending commit data, you can start resolving issues by including fixes -SHORT-ID> in your commit messages. For example, a commit message might look like:

Prevent empty queries on users

Fixes MYAPP-317

When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit, and, later, when that commit is part of a release, we’ll mark the issue as resolved.

Clubhouse

Create a more efficient workflow by linking your Sentry Issues with your Clubhouse Stories. Errors, features, and anything else you track in Clubhouse can now live side by side. The new Clubhouse integration has feature parity with the Clubhouse plugin. If you’re choosing between the two, we recommend installing the Clubhouse integration.

Installation

  1. In Sentry, navigate to Organization Settings > Integrations.

    Sentry's integrations page with Clubhouse at the top.

  2. Find the Clubhouse Integration and click Install.
  3. In the resulting modal, approve the permissions by clicking Install.

    Sentry's modal to install Clubhouse and approve permissions.

  4. Your Clubhouse Integration is ready to use!

Configuration

When linking an issue, you’ll need either an existing Clubhouse Story or you’ll need to create a Clubhouse Story.

Route 1: Clubhouse Story Exists

You can link a Sentry Issue to an existing Clubhouse Story.

  1. In Sentry, navigate to the specific Issue you want to link.
  2. Click on Link Clubhouse Issue under Linked Issues.

    Sentry's sidebar button for linking issues.

  3. Select the Issue you want to link.

    Sentry's modal to link an issue to an existing Story.

  4. Click Save Changes to submit the form.

  5. Click on the Clubhouse Story under Linked Issues. This will automatically take you to Clubhouse.

    Sentry's sidebar button illustrating that an issue is linked.

  6. In Clubhouse, you can review your Clubhouse Story and the linked external ticket to Sentry.

    Clubhouse web interface illustrating the linked Sentry issue.

Route 2: Create a Clubhouse Story Based on a Sentry Issue

You can take a Sentry Issue, create a Clubhouse Story, and link the two.

  1. In Sentry, navigate to the specific Issue you want to link.
  2. Click on Link Clubhouse Issue under Linked Issues.

    Sentry's sidebar button for linking issues.

  3. Add information to the created Clubhouse Story.

    A) Title of Story - auto-filled from the Sentry Issue, but also editable

    B) Description of Story - auto-filled from Sentry Issue, but also editable

    C) Project - additional data about the Project

    D) Requester - the person who created the Clubhouse Story and linked it to the Sentry Issue

    Sentry modal that creates a Clubhouse Story that's linked to a Sentry issue.

  4. Click Save Changes to submit the form.

  5. Click on the Clubhouse Story under Linked Issues. This will automatically take you to Clubhouse.

    Sentry's sidebar button illustrating that an issue is linked.

  6. In Clubhouse, you can review your Clubhouse Story and the linked external ticket to Sentry.

    Clubhouse web interface illustrating the linked Sentry issue.

GitHub

You can now use the data from your GitHub commits to help you find and fix bugs faster.

Configure GitHub

  1. In Sentry, navigate to Organization Settings > Integrations.
  2. If you have the legacy GitHub integration installed, you’ll see a button next to GitHub that says Upgrade. If you do not have the legacy GitHub integration installed, you’ll see a button that says Install.

  3. In the resulting modal, click Add Installation.

  4. A GitHub install window should pop up. Click Install.
  5. Select which repositories Sentry should have access to (or select all repositories).
  6. You should then be redirected back to the Sentry Integrations page.
  7. On your new GitHub instance in Sentry, click Configure.
  8. Add any repositories from which you want to collect commit data. Note: Make sure you have given Sentry access to these repositories in GitHub in the previous steps.

GitHub should now be enabled for all projects under your Sentry organization.

Commit Tracking

Commit tracking allows you to hone in on problematic commits. Learn more about commit tracking.

Suspect Commits and Suggested Assignees

Once you set up commit tracking, you’ll be able to see the most recent changes to files found in the issue’s stack trace with suspect commits.

For issues where the files in the stack trace match files included in commits sent to Sentry, you’ll see the suspect commit, with a link to the commit itself.

You’ll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.

Issue Management

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

Once you’ve navigated to a specific issue, you’ll find the Linked Issues section on the right hand panel. Here, you’ll be able to create or link GitHub issues.

Resolving in Commit/Pull Request

Once you are sending commit data, you can start resolving issues by including fixes -SHORT-ID> in your commit messages. For example, a commit message might look like:

Prevent empty queries on users

Fixes MYAPP-317

You can also resolve issues with pull requests by including fixes -SHORT-ID> in the title or description.

When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit or pull request, and, later, when that commit or pull request is part of a release, we’ll mark the issue as resolved.

GitHub SSO

Enable Single Sign-on

GitHub Enterprise

You can now use the data from your GitHub Enterprise commits to help you find and fix bugs faster.

Configure GitHub Enterprise

Add new GitHub App
  1. Make sure you’ve whitelisted Sentry’s outbound request IPs addresses for your GitHub Enterprise instance.
  2. In your GitHub Enterprise organization, navigate to Settings > Developer Settings > GitHub Apps and click to add a new New GitHub App.

Register new GitHub App
  1. First, you’ll need to generate a webhook secret. For example, in terminal:

     openssl rand -base64 500 | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1
    
  2. Then in GitHub, fill out the form as follows and click Create GitHub App.

    GitHub App Name sentry-app
    Homepage URL https://sentry.io
    User authorization callback URL https://sentry.io/extensions/github-enterprise/setup/
    Setup URL https://sentry.io/extensions/github-enterprise/setup/
    Webhook URL https://sentry.io/extensions/github-enterprise/webhook/
    Webhook secret Input your secret from the previous step
    Repository Administration Read-only
    Commit Statuses No Access
    Deployments No Access
    Issues Read & Write
    Pages No Access
    Pull Requests Read-only
    Repository Contents Read-only
    Single File No Access
    Repository Projects No Access
    Organization members Read-only
    Organization projects No Access
    Subscribe to Events  
    Pull Request Yes
    Push Yes
Install your GitHub App
  1. In Sentry, navigate to Organization Settings > Integrations.
  2. Next to GitHub Enterprise, click Install.

  3. Click Add Installation.

  4. Fill out the following form with information from your GitHub apps configuration page.

    You’ll need to generate a private key on your GitHub apps configuration page, and paste the entire contents into the GitHub App Private Key field.

    For example, in terminal:

     cat <YOUR_PRIVATE_KEY_FILE> | pbcopy
    
  5. Click Configure and then a GitHub install window will pop up. Select which repositories Sentry should have access to (or select all repositories) and click Install.

  6. You will then be redirected back to Sentry. On your new GitHub Enterprise instance, click Configure.

  7. Add any repositories that you want to collect commit data from. Note: Make sure you have given Sentry access to these repositories in GitHub in the previous steps.

GitHub Enterprise should now be enabled for all projects under your Sentry organization.

Commit Tracking

Commit tracking allows you to hone in on problematic commits. Learn more about commit tracking.

Suspect Commits and Suggested Assignees

Once you set up commit tracking, you’ll be able to see the most recent changes to files found in the issue’s stack trace with suspect commits.

For issues where the files in the stack trace match files included in commits sent to Sentry, you’ll see the suspect commit, with a link to the commit itself.

You’ll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.

Issue Management

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

Once you’ve navigated to a specific issue, you’ll find the Linked Issues section on the right hand panel. Here, you’ll be able to create or link GitHub issues.

Resolving in Commit/Pull Request

Once you are sending commit data, you can start resolving issues by including fixes -SHORT-ID> in your commit messages. For example, a commit message might look like:

Prevent empty queries on users
Fixes MYAPP-317

You can also resolve issues with pull requests by including fixes -SHORT-ID> in the title or description.

When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit or pull request, and, later, when that commit or pull request is part of a release, we’ll mark the issue as resolved.

GitLab

Sentry’s GitLab integration helps you find and fix bugs faster by using data from your GitLab commits. Additionally, you can streamline your triaging process by creating a GitLab issue directly from Sentry.

Configure GitLab

  1. In Sentry, navigate to Organization Settings > Integrations.

  2. Within Integrations, find the GitLab icon and click Install.

    GitLab icon and install button

  3. In the resulting modal, click Add Installation.

    Connect Sentry to a GitLab instance

  4. In the pop-up window, complete the instructions to create a Sentry app within GitLab. Once you’re finished, click Next.

    Configuration modal and Sentry app within GitLab

  5. Fill out the resulting GitLab Configuration form with the following information:

    1. The GitLab URL is the base URL for your GitLab instance. If using gitlab.com, enter https://gitlab.com/.

    2. Find the GitLab Group Path in your group’s GitLab page.

      GitLab page showing group path

    3. Find the GitLab Application ID and Secret in the Sentry app within GitLab.

      GitLab application id and secret

    4. Use this information to fill out the GitLab Configuration and click Submit.

      GitLab configuration form

  6. In the resulting panel, click Authorize.

  7. In Sentry, return to Organization Settings > Integrations. You’ll see a new instance of GitLab underneath the list of integrations.

  8. Next to your GitLab Instance, click Configure. Note: It’s important to configure to receive the full benefits of commit tracking.

    GitLab instance with connected group and highlighted configure button

  9. On the resulting page, click Add Repository to select which repositories in which you’d like to begin tracking commits.

    Add repository

Issue Management

Issue tracking allows you to create GitLab issues from within Sentry and link Sentry issues to existing GitLab issues.

  1. Select your issue

    List of unresolved issues

  2. Navigate to Linked Issues on the right panel of the issue’s page and click Link GitLab Issue.

    GitLab logo with Link GitLab Issue text

  3. You have two options to complete the issue link:

    1. In the pop-up, you can fill out the appropriate details in the Create tab, and then click Create Issue.

      pop-up modal to create issue

    2. Or, in the pop-up, you can click the Link tab, search the issue by name, and then click Link Issue. Note: Issues aren’t currently searchable by number.

      pop-up modal to search issue name

  4. To unlink an issue, click on the X next to its name under Linked Issues.

    GitLab logo and project next to an X icon

Commit Tracking

Commit tracking allows you to hone in on problematic commits. With commit tracking, you can better isolate what might be problematic by leveraging information from releases like tags and metadata.

Once you’ve configured both release and commit tracking, you’ll be able to see more thorough information about a release: who made commits, which issues were newly introduced by this release, and which deploys were impacted.

Dashboard with last commit highlighted

When you investigate deeper into that commit, you can leverage information from metadata like tags.

Issue detail highlighting tags

Broadly, this lets you isolate problems in order to see which commits might be problematic.

Learn more about release and commit tracking.

Suspect Commit

Once you are tracking the commits, the ‘suspect commit’ is the commit that likely introduced the error.

One special benefit of using Sentry’s Commit Tracking is the ability to know the suspect commit that likely caused the error, with a suggested plan of action for how to rectify the error. For example, after pinpointing the suspect commit, you can also identify the developer who made the commit and assign them the task of fixing the error.

Issue detail highlighting suspect commits

Here is where you can find info for suspect commit setup.

Resolve via Commit or PR

Once you’ve added a repository (see configuration step 8), you can start resolving issues by including fixes -ID> in your commit messages. You might want to type something in the commit like: “this fixes MyApp-AB12” or “Fixes MyApp-317”. The keyword to include is fixes. You can also resolve issues with pull requests by including fixes -ID> in the title or description. This will automatically resolve the issue in the next release.

A -ID> may look something like ‘BACKEND-C’ in the image below.

Issue detail highlighting suspect commits

Troubleshooting

FAQ:

  • I’m using GitLab on-premise. Do I need to whitelist Sentry’s IP addresses?
    • Yes. You can find our IP ranges here .
  • Do you support subgroups?
    • Currently, we only support subgroups for users using GitLab 11.6 or higher.
  • My repositories are hosted under my user account, not a group account. Can I still use this integration?
    • Unfortunately, not. The GitLab integration only works for repositories that are hosted under group accounts.
  • Are there pricing restrictions?
  • Who has permission to install this?
    • You must have both owner/manager permissions in Sentry and owner permissions in GitLab to successfully install this integration.

JIRA

Connect errors from Sentry with your Jira issues.

Installing Jira with Sentry

  1. In Sentry, navigate to Organization Settings > Integrations.
  2. Next to Jira, click Install.
  3. Click on the Jira Marketplace button to begin installing the Sentry app through the Jira marketplace.
  4. Select which Sentry organizations you’d like to use Jira with, and Save Settings.
  5. 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.

Issue Management

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

To configure Issue management, 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.

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, it will automatically update in Jira.

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

JIRA Server

Connect errors from Sentry with your Jira Server issues.

Installing Jira Server with Sentry

I. 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.

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 > 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 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
  5. Click Continue. You should be returned to the Configure Application Links page, where you should 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 our 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
III. Connect your Jira Server application with Sentry
  1. In Sentry, 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.

Issue Management

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

To configure Issue management, 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.

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, it 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.

Rookout

Rookout’s new integration adds a layer of depth to Sentry Issues by allowing you to jump right from an Issue to a non-breaking breakpoint on the line that caused the error.

Installation

  1. In Sentry, navigate to Organization Settings > Integrations.
  2. Find the Rookout Integration and click Install.

    Sentry's integrations page with Rookout at the top.

  3. In the resulting modal, approve the permissions by clicking Install.

    Sentry modal indicating that permissions need installation.

  4. Your Rookout Integration is ready to use!

Use Integration in Stack Trace

After installing Rookout in Sentry, you can go straight to the line of code in your stack trace, and click the Rookout icon. That will take you directly to the same line of code in the same file inside Rookout.

  1. In Sentry, navigate to the specific Issue you want to link and navigate to the Stack Trace.
  2. In the Stack Trace, you’ll see the option to open the line in Rookout by clicking on the Rookout icon.

    Sentry stack trace showing the Rookout icon on a specific line.

  3. Clicking on the Rookout icon takes you to Rookout’s web UI where you can continue the debugging process. Rookout makes the best guess for the corresponding project and file in its web UI and will take you to the correct line of code in the file.

    Sentry modal indicating that permissions need installation.

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.

Slack

The global Slack integration creates workflows for your team. Now you can triage, resolve, and ignore Sentry issues directly from Slack.

Configure Slack

  1. In Sentry, navigate to Organization Settings > Integrations.

  2. At the top of the page, you’ll see the available Global Integrations list, which includes Slack. Click Install to integrate Sentry with your Slack workspace(s).

  3. Click Add workspace.

  1. After you’ve connected to the correct workspace, click Continue.

  2. On the next page, you can choose the scope of channels you’d like Sentry to access. You can specify all public channels or choose specific channels. Then click Install.

  3. Your Organization Integrations page will refresh and show the Slack workspace you just added.

    You’ll also see the Sentry app join the Slack channels you specified right away.

Now your Slack integration is available to all projects in your Sentry organization. See the next section to configure your notification settings.

Configure Alert Rules

  1. Confirm your Slack workspace is configured globally for your Sentry organization by navigating to Organization Settings > Integrations.

  2. Click Configure and you’ll see the available Slack workspaces for your project. From this page, you can click on Add Alert Rule for this project to go directly to your Alert Rule settings.

    You can also access Alerts from your Project Settings. From here, you can configure when notifications are sent to your Slack workspace(s).

  1. Click New Alert Rule to configure a new Alert.

    For any existing Alert Rules, you can edit the rule to update the Slack channel routing. When you click Edit Rule, under Take these actions you can specify your Slack channel(s):

    After selecting Send a notification to the {workspace} Slack workspace to {channel} and include tags {tags}, you can specify the workspace, channel(s), and tags you’d like to include with your Alert Rule.

    You can add Alert Rules routing to as many Slack channels as you’d like.

  2. Then once you receive a Slack notification, you can use the Resolve, Ignore, or Assign buttons to update the Issue in Sentry.

Deleting the legacy Slack integration

Once you configure the global Slack integration and Alert Rules, you can disable the old Slack integration. You’ll need to go to each project that has it enabled and disable it. We recommend disabling the legacy integration after setting up the global integration.