Getting Started Guide

So, you want to install and setup BugSplat? That's excellent news 🎉

This quick start guide walks you through the essentials of getting started with BugSplat.

What is BugSplat?

BugSplat is a crash reporter that delivers detailed and actionable data on crashes that your end-users experience as they use your software.

This crash data highlights problems in your code, helping you find the cause of your most important defects.

Creating your first database

To get started submitting crashes to BugSplat, you need to create a database where you can post crashes.

To do this, go to our Database page. Make sure to pick a name which allows for easy identification.

Choosing your first integration

BugSplat works on many platforms, allowing you to have one central repository for your software crashes across all your environments.

Each platform we integrate with has it's own documentation. Find a list of our platforms here.

You can download the SDK for each platform on the Download page.

Submitting a test crash

Most of the platforms we integrate with we have a test application that allows you to post a sample crash to a public database. This is a great way to learn how BugSplat works and understand the type of data you can expect in a crash report.

Find these test applications here or in the platform-specific documents.

To access the public database sign in with the username ‘Fred’ and password ‘Flintstone’. Yabadabadoo!

Getting symbols working correctly

Debug symbols are required to get symbolic call stacks for most platforms, which means they are critical getting complete data on your crashes.

There are two ways to up upload symbols. You can either upload them manually via the Symbols page or by using SendPdbs.

Without correctly uploaded symbols your crash report data will be incomplete.

Searching and sorting your crash data.

Once your application is posting crashes to BugSplat, you can use our tools to sort and search through your data.

The first tool we have is a column specific sort feature found on the Crash, Summary, and individual StackKey pages. Right click on the header of the column you want to sort through and use the tooltip which pops up.

View of bugsplat dropdown menu

The second tool we have allows for robust and specific searches of your crashes across applications. This tool is found on the Search page and is a favorite of teams who have a high crash volume.

Organizing crash data

Knowing how we organize, sort, filter and search this data helps you get the most out of BugSplat.

Each time your application crashes BugSplat generates a crash report. This report has a unique number and contains essential data on the crash. All crashes are viewable on the Crash page.

To view an individual crash report, click on the Crash ID button on the left-hand column of the table.

Crash ID button click demo

BugSplat goes a step further and groups similar crashes together on the Summary page. We call this grouping by StackKey; meaning crashes are sorted into groups which share a similar crash stack.

To view all the crashes in a StackKey, click on the link in the left-hand column.

Crash ID button click demo

When your application has relatively few crashes you’ll want to spend a lot of time looking through each crash on the Crash page.

As your application grows and becomes wildly successful, you’ll likely spend more time on the Summary page. This view allows you to see which crashes are occurring most frequently in your user base

Integrating with your tools

The teams that get the most out of crash reporting use BugSplat as a critical step in their support and development process.

The ideal BugSplat workflow allows you to quickly identify your significant crash defect, assign them as tasks in your bug tracker, find fixes to your crashes, test those crashes, and push code which fixes the problem.

To facilitate this workflow we integrate with the tools you use everyday.

Integrate with your team's messaging app or email to deliver alerts as crashes happen or when a new crash type is found.

Integrate with your defect tracker to create new issues based on crash reports with one click.

Have a tool you want us to integrate with BugSplat? We build integrations based on our customer's requests, so shoot us a note at support@bugsplat.com

Inviting your team members

If you’ve been following this guide step-by-step, then it is well past time to get your team onboard and working with BugSplat. There are defects to chase down and code to fix!

Luckily adding your team members is simple with BugSplat. Navigate to the User page and enter the email of those teammates you want to invite to your BugSplat account.

Once added an email is sent prompting them to create an account and start fixing bugs!