Set up one or more projects

The first things you should do is create a project within your Backtrace instance.  A project is a container that lets you organize your errors. You have to create at least one project to submit your errors to.

Best practice is to create one project for each application you wish to capture errors for. Each project has its own workflow integrations, attributes, symbol archives, and submission tokens.

Upload your symbols

If you are using a minidump-based integration - this includes Breakpad, Crashpad, Unreal and C#- you will need to upload your symbol files in order to see full debug info on your errors.

For Windows users, make sure that you upload both the symbol file (.sym or .pdb format) as well as the corresponding .exe or .dll file. We recommend that you upload these together in a .zip file.

For more information about working with symbols, see Symbolication.

Submit your errors

At this point, you should try submitting one or more errors to your instance to verify that your integration is set up properly.

The way to do this varies depending on your integration type. However you will need to make sure you have the correct submission token and submission url.

For more information about submitting errors, see our Integration Guides.

Add attributes

We highly recommend that you add attributes to your project and your errors - the more the better!

Attributes are important because they allow you to aggregate and filter on important data within the query builder.

You will need to both attach the attributes to your errors, as well as declare those attributes within the Backtrace UI.  

For more information about attributes, see Attributes.

Add a Workflow Integration

Workflow integrations allow you to have Backtrace automatically alert users of new errors via a popular collaboration platform such as Slack, or a ticketing system like JIRA.  These are just a couple of examples - Backtrace supports many more third-party integrations!

We recommend setting up an integration to any third-party service you use that we support.  

For more information, see Workflow Integrations.

Invite other users

Backtrace makes it easy to add additional engineers to the system. For Backtrace-hosted instances, simply go to Configure Organization, then users, then invite a user. You can allow easily allow them to request an invitation from the login page by adding a whitelisted domain.

For our enterprise users who are hosting their own instance, you'll also need to set up SMTP in coronerd before users can receive invitations.

For more information, see Account Management.