Backstage Sentry Plugin

Correlate services with problems in production

Getting started is simple

Ensure you have the Sentry Backend plugin installed. See the notes below to learn how to add a Sentry API token to Backstage.

Install the plugin in your Backstage instance

yarn add @backstage/plugin-sentry

Add the plugin to the list of plugins

// packages/app/src/plugins.ts
export { plugin as Sentry } from '@backstage/plugin-sentry';

How it looks

Things to know

The Backstage backend must have access to a SENTRY_TOKEN API key environment variable.

To get an API key, first create an internal application in the Sentry UI. Do this at the organization level, rather than the personal level.

Give your application a name and a Webhook URL, then be sure to give the ability to read issues and projects. These will be displayed in Backstage so it’s important that the plugin can access them.

Creating an internal application in the Sentry UI

Once you have an internal application, you can create a token. Run the Backstage backend with this token.

env SENTRY_TOKEN=123abc yarn start

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.

We will never sell or share your email address.