BugSnag

BugSnag is an application stability monitoring platform that provides error tracking and analytics.

Integrating BugSnag with Cortex allows you to:

• View errors on entity pages in Cortex, giving you insight into your entity's operational maturity

• Create Scorecards that include rules related to BugSnag errors

How to configure BugSnag with Cortex

Prerequisites

Before getting started:

• Create a BugSnag auth token in your BugSnag account's settings page under "My account."

• You must have the Configure integrations permission in Cortex.

If you're using a self-hosted instance of BugSnag, you'll need to verify that your Cortex instance is able to reach the BugSnag instance. We route our requests through a static IP address. Reach out to support at [email protected] to receive details about our static IP. If you're unable to directly allowlist our static IP, you can route requests through a secondary proxy in your network that has this IP allowlisted and have that proxy route traffic to your BugSnag instance.

Configure the integration in Cortex

1. In Cortex, navigate to the BugSnag settings page:

   1. In Cortex, click your avatar in the lower left corner, then click Settings.

   2. Under "Integrations," click BugSnag.

2. Click Add configuration.

3. Configure the integration form:

   • Auth token: Enter the auth token you generated in BugSnag.

   • Organization slug: Enter your BugSnag organization slug.

     • You can find this in your BugSnag URL, e.g., https://app.bugsnag.com/organizations/{SLUG}/stability-center.

   • Host: If using a custom BugSnag instance, enter the URL here without the API path (e.g., bugsnag.getcortexapp.com).

4. Click Save.

After saving your configuration, you are redirected to the BugSnag integration settings page in Cortex. In the upper right corner of the page, click Test configuration to ensure BugSnag was configured properly.

How to connect Cortex entities to BugSnag projects

Discovery

By default, Cortex will use the entity tag (e.g. my-entity) as the "best guess" for BugSnag projects. For example, if your entity tag is my-entity, then the corresponding project in BugSnag should also be my-entity.

If your BugSnag projects don’t cleanly match the Cortex entity tag, you can override this in the Cortex entity descriptor.

Editing the entity descriptor

You can define projects under the x-cortex-bugsnag block:

x-cortex-bugsnag:
  project: my-project

Field	Description	Required
project	Project key defined in BugSnag	✓

Using the BugSnag integration

Viewing BugSnag errors on an entity

Error data will appear on an entity's details page. You can find the total number of detected errors and a full list on the Error tracking page in the entity's side panel. Error data is fetched live.

Each error in the list will display with an Error, Info, or Warning tag based on the severity applied to a given error in BugSnag.

Scorecards and CQL

With the BugSnag integration, you can create Scorecard rules and write CQL queries based on BugSnag projects and issues.

See more examples in the CQL Explorer in Cortex.

Check if BugSnag is set

Check if an entity has a registered BugSnag project.

Definition: bugsnag (==/!=) null

Example

This expression can be used to write a Scorecard rule to make sure each entity has a registered BugSnag project:

bugsnag != null

This is also a good way to double-check that the integration is synced and reporting frequently.

Number of issues

Count all unresolved issues in BugSnag or counts number of issues for a given query. By default, will count all unresolved issues.

Definition: bugsnag.numOfIssues(query: Text | Null)

Example

For a Scorecard focused on operational maturity, you can pull in error data from BugSnag to make sure your entities have no or few errors.

bugsnag.numOfIssues() < 2

To set a more specific standard, you can also create a rule based on a filter.

bugsnag.numOfIssues("filters[error.status][][type]=example")

Still need help?​

The following options are available to get assistance from the Cortex Customer Engineering team:

• Email: [email protected], or open a support ticket in the in app Resource Center

• Chat: Available in the Resource Center

• Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your Customer Success Manager.