Bugsnag

Bugsnag provides error reporting libraries for major software platforms which automatically detect and report errors in your applications, and capture diagnostic data required to help you reproduce and fix each error.

Connection compatibility

Destination Information
Status: Generally Available Supported sources: Android (Java) , Android (Kotlin) , iOS (Obj-C) , iOS (Swift) , Web Refer to it as Bugsnag in the Integrations object.

Connection Modes
Source	Cloud mode	Device mode	Hybrid mode
Android (Java)
Android (Kotlin)
iOS (Obj-C)
iOS (Swift)
Web

Supported Message Types
Source	Identify	Page	Track	Screen	Group	Alias	Record	AudienceList
Device mode
Android (Java)
iOS (Obj-C)
Web

In the web device mode integration, that is, using JavaScript SDK as a source, RudderStack loads the Bugsnag native SDK from the https://d2wy8f7a9ursnm.cloudfront.net/ domain.

Based on your website’s content security policy, you might need to allowlist this domain to load the Bugsnag SDK successfully.

Get started

Once you have confirmed that the platform supports sending events to Bugsnag, follow these steps:

1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select Bugsnag.
2. Assign a name to the destination and click Next.

Connection settings

To successfully set up Bugsnag as a destination, you will need to configure the following settings:

• Bugsnag API Key: Enter your BugSnag API key. You can find the API key in your Bugsnag dashboard under Settings > Project Settings.
• Use device-mode to send events: As this is a device mode-only destination, this setting is turned on by default and cannot be toggled off.
• Release Stage: Use this setting to specify the release stage of your app:
  • Toggle it on for Development stage.
  • Keep it toggled off for Production stage.
• SSL: This option is turned on by default and causes RudderStack to use SSL while sending data to Bugsnag.

Adding Bugsnag to mobile project

Once you add Bugsnag as a destination in the RudderStack dashboard, follow these steps to add it to your mobile project depending on your integration platform:

repositories {
    mavenCentral()
}

implementation 'com.rudderstack.android.sdk:core:1.0.1-beta.1'
implementation 'com.rudderstack.android.integration:bugsnag:0.1.0-beta.1'

// initialize Rudder SDK
val rudderClient =
    RudderClient.getInstance(
        this,
        WRITE_KEY,
        RudderConfig.Builder()
            .withDataPlaneUrl(DATA_PLANE_URL)
            .withFactory(BugsnagIntegrationFactory.FACTORY)
            .build()
    )

pod 'Rudder-Bugsnag', '0.1.0-beta.1'

#import "RudderBugsnagFactory.h"

RudderConfigBuilder *builder = [[RudderConfigBuilder alloc] init];
[builder withDataPlaneUrl:<your_data_plane_url>];
[builder withFactory:[RudderBugsnagFactory instance]];
[RudderClient getInstance:<your_write_key> config:[builder build]];

pod 'RudderBugsnag', '~> 1.0.0'

import RudderBugsnag

@import RudderBugsnag;

let config: RSConfig = RSConfig(writeKey: WRITE_KEY)
            .dataPlaneURL(DATA_PLANE_URL)

RSClient.sharedInstance().configure(with: config)
RSClient.sharedInstance().addDestination(RudderBugsnagDestination())

RSConfig *config = [[RSConfig alloc] initWithWriteKey:WRITE_KEY];
[config dataPlaneURL:DATA_PLANE_URL];

[[RSClient sharedInstance] configureWith:config];
[[RSClient sharedInstance] addDestination:[[RudderBugsnagDestination alloc] init]];

Identify

The identify method lets you identify a user and associate them to their actions. It also lets you record any traits about them like their name, email, etc.

A sample identify call is shown below:

rudderanalytics.identify("1hKOmRA4el9Zt1WSfVJIVo4GRlm", {
  name: "Alex Keener",
  email: "alex@example.com",
});

Bugsnag will show the userId and traits in the Users tab of each error.

Error reporting

Along with user-specific information, you can also use Bugsnag to track handled exceptions data to your dashboard using Bugsnag’s native methods. See the Bugsnag documentation for more information on these functions.

FAQ

Where can I find the Bugsnag API Key?

1. Log in to your Bugsnag dashboard.
2. Click Settings at the top right corner.
3. Click Project Settings to find the API key as shown:

What is meant by release stage?

You can distinguish errors that happen in different stages of your app’s release process, for example, production, development, etc.

Do I need to use SSL to send the event data to Bugsnag?

RudderStack recommends using SSL to send data to Bugsnag in web device mode.