Getting started guide

Understand how Bugsnag works, how to add Bugsnag to your apps, and estimated times for implementation.

How Bugsnag works

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

Errors captured by our reporting libraries are sent to your Bugsnag dashboard in real-time, allowing you and your team to triage and prioritize each error.

Quickstart

Adding Bugsnag to your apps typically takes under 15 minutes. After following these steps, crashes and unhandled exceptions will be reported to your Bugsnag dashboard.

Step 1: Sign up (1 min)

Sign up here for a free trial of Bugsnag.

If you have received an invitation to join an existing Bugsnag organization, you can access Bugsnag after signing in.

Step 2: Create a project (1 min)

Projects represent a single application that Bugsnag monitors for errors. When creating a project, we’ll generate a 32-character “project API key” which uniquely identifies your application to Bugsnag.

Create a project for the app you wish to monitor on your Bugsnag dashboard by providing your application’s name and platform type.

Step 3: Invite collaborators (1 min)

Invite collaborators to your Bugsnag project during the project creation process. Invitees will receive email notifications inviting them to your application, and will be able to view and triage errors captured by Bugsnag.

You can always add collaborators at a later stage from the Bugsnag settings center.

Step 4: Download and install the error reporting library (5 mins)

Bugsnag provides error reporting libraries for every major software platform which automatically detect and report errors in your applications.

Follow the Installation instructions on the platform integration guide for your platform to download and install the appropriate library.

Step 5: Initialize Bugsnag (5 mins)

You’ll next need to initialize Bugsnag in your application, by setting your project API key.

Follow the Basic configuration instructions on the platform integration guide for your platform.