Bugsnag

Monitor errors in Bugsnag for your service in Backstage.

Plugin details
Created by	Roadie
Category	Monitoring
Source	GitHub
Type	Open-source plugin

Configuration

Application configuration YAML

No action required

This plugin requires a backend proxy configuration to make calls to Bugsnag with authentication. The following configuration is set by default and you do not need to change anything:

proxy:
  ...
  '/bugsnag/api':
    target: 'https://api.bugsnag.com'
    headers:
        Authorization: 'token ${BUGSNAG_PERSONAL_TOKEN}'
        X-version: '2'

Secrets

Generate a Personal Auth Token and set it as variable of BUGSNAG_PERSONAL_TOKEN, For instructions on how to create a Personal Auth Token, read the instructions.

Delegate proxy

No action required

This plugin does not require a delegate proxy to be set up because Bugsnag is publicly accessible.

Layout

No action required

This plugin exports a UI card that you can show on the Overview tab of a service or any other layout page. Go to Configure → Layout, select Service in the dropdown menu, and then you could find following already added:

- component: EntityBugsnagErrorsOverviewTable

Annotations

To configure the plugin for a service in the software catalog, set one of the following annotations in its catalog-info.yaml definition file.

The following configuration is recommended:

metadata:
  annotations:
    bugsnag.com/project-key: <organization-name>/<project-name>

Note that you must use the full names, not the slugs. These values can be found in Bugsnag settings dashboard, under organization and project settings.

Support

The plugin is currently owned by Roadie and managed in the Roadie Backstage Plugin Repository as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.