LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • How to configure BugSnag with Cortex
  • Prerequisites
  • Configure the integration in Cortex
  • How to connect Cortex entities to BugSnag projects
  • Discovery
  • Editing the entity descriptor
  • Using the BugSnag integration
  • Viewing BugSnag errors on an entity
  • Scorecards and CQL
  • Still need help?​

Was this helpful?

Export as PDF
  1. Ingesting data into Cortex
  2. Integrations

BugSnag

Last updated 18 days ago

Was this helpful?

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 that include rules related to BugSnag errors

How to configure BugSnag with Cortex

Prerequisites

Before getting started:

  • Create a in your 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 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 :

    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

Scorecards and CQL

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

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
bugsnag.numOfIssues("filters[error.status][][type]=example")

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

  • 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.

Error data will appear on an . 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 applied to a given error in BugSnag.

See more examples in the in Cortex.

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

Still need help?

Email: , or open a support ticket in the in app Resource Center

entity's details page
severity
CQL Explorer
filter
​
help@cortex.io
BugSnag
BugSnag auth token
BugSnag account's settings page
help@cortex.io
BugSnag settings page
Scorecards