backstage
Sentry Plugin
The Sentry Plugin displays issues from Sentry.
Getting Started
- Install the Sentry Plugin:
# From your Backstage root directoryyarn --cwd packages/app add @backstage/plugin-sentry
- Add the
EntitySentryCard
to the EntityPage:
// packages/app/src/components/catalog/EntityPage.tsx
import { EntitySentryCard } from '@backstage/plugin-sentry';
const overviewContent = ( <Grid container spacing={3} alignItems="stretch"> // ... <Grid item xs={12} sm={6} md={4}> <EntitySentryCard /> </Grid> // ... </Grid>);
You can also import the full-page
EntitySentryContent
extension if you want to have a dedicated sentry page:
// packages/app/src/components/catalog/EntityPage.tsximport { EntitySentryContent } from '@backstage/plugin-sentry';const serviceEntityPage = (<EntityLayout>// ...<EntityLayout.Route path="/sentry" title="Sentry"><EntitySentryContent /></EntityLayout.Route>// ...</EntityLayout>);
- Add the proxy config:
# app-config.yaml
proxy: '/sentry/api': target: https://sentry.io/api/ allowedMethods: ['GET'] headers: Authorization: Bearer ${SENTRY_TOKEN}
sentry: organization: <your-organization>
-
Create a new internal integration with the permissions
Issues & Events: Read
(https://docs.sentry.io/product/integrations/integration-platform/) and provide it asSENTRY_TOKEN
as env variable. -
Add the
sentry.io/project-slug
annotation to your catalog-info.yaml file:
apiVersion: backstage.io/v1alpha1kind: Componentmetadata: name: backstage description: | Backstage is an open-source developer portal that puts the developer experience first. annotations: sentry.io/project-slug: YOUR_PROJECT_SLUGspec: type: library owner: CNCF lifecycle: experimental
Demo Mode
The plugin provides a MockAPI that always returns dummy data instead of talking to the sentry backend.
You can add it by overriding the sentryApiRef
:
// packages/app/src/apis.ts
import { createApiFactory } from '@backstage/core-plugin-api';import { MockSentryApi, sentryApiRef } from '@backstage/plugin-sentry';
export const apis = [ // ...
createApiFactory(sentryApiRef, new MockSentryApi()),];