RoadieDocs

Sentry

Published on February 23rd, 2021

Introduction

In order to use the Backstage Sentry plugin with Roadie, you must securely provide Roadie with an API key which it can use to access the Sentry API.

Connect Roadie to Sentry

Step 1: Set your Sentry organization

Click the dropdown in the top left corner of the Sentry UI and click “Organization settings”.

Copy the value of the Organization Slug from the settings. The value shown here is roadie. You will have a different value.

organizaton setting in Sentry UI

Go to the Administration Settings page and set the Sentry organization name.

sentry-settings-page.png

Step 2: Get a Sentry token

Create an Internal Integration using the Sentry UI. Click “Settings” in the left sidebar, then “Developer Settings”. Next click the “New Internal Integration” button.

Give the integration a name like “Roadie”.

a form on the sentry UI with the name input filled out with the text Roadie

Give the integration the ability to read projects and issues.

a list of permissions on the Sentry UI with projects and issues set to Read

Click the “Save Changes” button.

Copy the token that Sentry displays.

an api token in the Sentry UI

Step 3: Add the token to Roadie

Visit https://your-company.roadie.so/administration/settings/secrets.

Click the pencil icon beside SENTRY_TOKEN. Enter the token you copied from the Sentry UI into the input in the dialog that pops up.

a dialog box with an input called Secret Value. The Sentry token is pasted inside.

Click Save.

Wait a few moments for the secret to be applied.

Step 4: Add the Sentry annotation to a component

Using the Sentry UI, find a Sentry project which you would like to associate with a component in Roadie.

Click the gear icon beside your project name to view the project settings.

a page for a sample service in Sentry with a gear icon near the top left of the screen

Copy the name from the Project settings

settings page for a project on Sentry with inputs for name and platform

Edit the catalog-info.yaml for the component you wish to associate with this Sentry project and add the sentry.io/project-slug annotation.

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: sample-service
  description: Sample service
  annotations:
    sentry.io/project-slug: sample-service

Commit and push this change and Roadie should pick it up within a few minutes.

References

  1. Sentry integration docs