Last updated Apr 16, 2024

Integrate Compass with Sentry

What is Sentry?

Sentry is a self-hosted and cloud-based application for performance monitoring and error tracking that helps software teams.

Compass currently supports Sentry as a tool to:

  • visualize alerts on the activity feed
  • provide metric around issues

Integrate Compass with Sentry

With the Sentry app for Compass, you can configure your Sentry alerts to send errors & alerts to Compass and then view them, along with other events across dependencies, on the Compass activity feed. The Sentry app also gives you related metrics on your components which can be used with a scorecard to help identify components that need attention. To integrate Compass with Sentry, you must first install the Sentry app in Compass. Then, you connect Compass to the Sentry organization that contains the projects that you want to track.

When you integrate an app with Compass, other Compass users can view events and metrics data sent from the app to Compass, even if they don't have access to that data in the underlying app. For example, when you integrate Bitbucket with Compass, someone who doesn't have access to a repository can see the events and metrics related to that repository in Compass. The same applies to data sent from this app to Compass.

Before you begin

  • Ensure that you’re an owner or manager on your Sentry organization you want to connect to or work with your organization owner or manager to install this Sentry app.
  • Ensure that you’re an admin on your Compass instance.

Perform the integration

Learn more about internal Sentry integrations

Integrate Compass with Sentry:

  1. Select Apps from the top navigation bar in Compass.
  2. Select Install on the Sentry app card. This installs the Sentry app in Compass.
  3. Select Configure on the Sentry app card.
  4. Authorize the Sentry app to access Compass on your behalf if you haven't previously done so.
  5. You should now see instructions for how to create an Internal Integration in Sentry which is required for the Compass integration. Important: Follow the steps displayed as it contains a unique URL you will need to use.
  6. After creating the Internal Integration in Sentry, enter the Authorization token, Client Secret and Organization Slug (part of your Sentry URL and can also be found in Sentry settings) from Sentry.
  7. Select Connect account.

Add alerts information from Sentry to a component

With the Sentry app Compass you can associate a Sentry project with a Compass component to show issues information directly in Compass. It will watch for alerts belonging to the associated Sentry project to plot those on the activity feed and calculate issue-related metric.

  1. In Compass, navigate to a component you want to connect to your Sentry issues information.
  2. On the component’s overview page, you’ll see the Dashboards, Project, Other links sections on the right side of the component’s details.
  3. Paste the link to your Sentry project to one of these sections.
  4. Optionally, enter link text to be displayed as the link’s title.
  5. Select Add.
  6. In Sentry, navigate to Alerts and for each Alert applicable to this component, add an action to send a notification to an integration. You should see an option to choose “Compass” as the integration target. Sending a test notification from Sentry should now show on your Compass activity feed letting you know it’s been successfully connected.

Your alerts information and metric are displayed and updated from Sentry. If for some reason you encounter an error after adding a Sentry project, make sure you entered the right type of link (e.g. https://yourorganization.sentry.io/projects/yourproject/).

View alerts from Sentry

First be sure to complete the Add alerts information from Sentry to a component section.

  1. In Compass, navigate to a component you want to view alerts for.
  2. Select Activity on the left side of the component's details.
  3. See recent alerts on the Timeline or List views of the activity feed for the component.

See metric about issues from Sentry

First be sure to complete the Add alerts information from Sentry to a component section.

  1. In Compass, navigate to a component you want to view issues for.
  2. View the metric section of the component's details.

Supported metrics: Learn more about Compass metrics.

MetricDescriptionHow it's calculated
Unresolved Sentry issuesTotal number of unresolved issues.Issues from associated Sentry project.

If you do not see metric updating it could be that you have not had any issues recently (hooray!). Make sure you also added the correct Sentry project link to the component.

Disconnect the Sentry organization connected with Compass

Disconnecting your Sentry account means issues information will no longer be displayed for your components.

Before you begin

  • Ensure that you’re admin on your Compass instance.

Disconnect the Sentry organization

To disconnect a Sentry organization from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the Sentry app card.
  3. Select Disconnect. The Sentry organization is disconnected from Compass and the page refreshes to its initial state with no organization connected.

Uninstall the Sentry app from Compass

If you no longer want to use the Sentry app from Compass you can uninstall it.

Before you begin

  • Ensure that you’re an admin on your Compass instance.

Uninstall the Sentry app

To uninstall the Sentry app from Compass:

  1. In Compass, from the top navigation bar, select Apps.
  2. Select Configure on the Sentry app card.
  3. Select Uninstall on the Sentry app card. The Sentry app uninstalls from Compass.

Troubleshooting

I don't see the Compass integration option for alert rules in Sentry

If you don't see the option to send alert notifications to Compass, verify you have the integration setup properly.

  1. In Sentry, click Settings, then Integrations, and look for Compass.
  2. If you see Compass, edit the integration and verify the settings match the below. If you do not see Compass, then select Create New Integration to create it.
  3. Enter the following details:
    • Select Internal Integration
    • Name: Compass
    • Webhook URL: See the Sentry app page in Compass for your webhook details.
    • Toggle Alert rule action to on
    • Select Read permission for Project, Issue & Event, and Organization
    • Select issue in the Webhooks section
  4. Select Save Changes.

You should now see Compass as an option for a notification target in Sentry Alert rules.

Rate this page: