> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/internal-developer-portal/use-idp/plugins/available-plugins/bug-snag.md).

# Bugsnag

| Plugin details |                                                                                                                    |
| -------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Created by** | Roadie                                                                                                             |
| **Category**   | Monitoring                                                                                                         |
| **Source**     | [GitHub](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-bugsnag) |
| **Type**       | Open-source plugin                                                                                                 |

### Configuration <a href="#configuration" id="configuration"></a>

#### Application configuration YAML <a href="#application-configuration-yaml" id="application-configuration-yaml"></a>

*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:

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

#### Secrets <a href="#secrets" id="secrets"></a>

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](https://bugsnagapiv2.docs.apiary.io/#introduction/authentication/personal-auth-tokens-\(recommended\)).

#### Delegate proxy <a href="#delegate-proxy" id="delegate-proxy"></a>

*No action required*

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

### Layout <a href="#layout" id="layout"></a>

*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:

```yaml
- component: EntityBugsnagErrorsOverviewTable
```

![](/files/VFrjp7rExlNRdKcDcYkr)

### Annotations <a href="#annotations" id="annotations"></a>

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:

```yaml
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 <a href="#support" id="support"></a>

The plugin is currently owned by Roadie and managed in the [Roadie Backstage Plugin Repository](https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-bugsnag) as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.