Backstage Rollbar Plugin

Correlate services with problems in production

Getting started is simple

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

Add Rollbar configuration to your Backstage app

# app.config.yaml
rollbar:
  organization: organization-name
  # used by rollbar-backend
  accountToken: ${ROLLBAR_ACCOUNT_TOKEN}

Install the plugin in your Backstage instance

yarn add @backstage/plugin-rollbar

Add the plugin to the list of plugins

// packages/app/src/plugins.ts
export { rollbarPlugin } from '@backstage/plugin-rollbar';

Add the plugin to your Backstage instance.

// packages/app/src/components/catalog/EntityPage.tsx
import { EntityRollbarContent } from '@backstage/plugin-rollbar';

const serviceEntityPage = (
  <EntityLayout>
    ...
    <EntityLayout.Route path="/rollbar" title="Rollbar">
      <EntityRollbarContent />
    </EntityLayout.Route>
    ...
  </EntityLayout>
);

Annotate entities with the rollbar project slug

# catalog-info.yaml
metadata:
  annotations:
    rollbar.com/project-slug: organization-name/project-name

Found a mistake? Update these instructions.

How it looks

A screenshot of the Rollbar plugin. It is showing a list of errors.

Things to know

You can find account access tokens by navigating to your organization settings -> Account Access Tokens in your Rollbar account.

Rollbar access token page

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.