Crashpad
Last updated
Was this helpful?
Last updated
Was this helpful?
Want help building Crashpad? View our step-by-step guide to help you more quickly get started .
Crashpad is the latest open-source crash reporting tool built by Google and is the successor to the popular Breakpad crash reporter. Crashpad allows you to submit minidumps to a configured URL after a crash occurs in your product. The official Crashpad documentation is available . Crashpad and Breakpad are 'wire compatible.' The crash reports created by both systems are processed similarly on our backend.
To begin, and unzip the BugSplat Crashpad software development kit. The download contains a sample Crashpad application and a compiled version of Crashpad for Windows.
It's also possible to download and build Crashpad yourself. This step is required if you are targeting an OS other than Windows. See our doc for our step-by-step guide to building Crashpad.
To get a feel for the BugSplat service, experiment with the myCrashpadCrasher sample application before enabling your application. You can find the Visual Studio project file located in your download folder at ...\BugSplatCrashpad\BugSplat\samples\myCrashpadCrasher\myCrashpadCrasher.vcxproj.
Run the sample application without the debugger attached to post a crash report to our public "fred@bugsplat.com" database. To view the report, log in to the public database using the account "fred@bugsplat.com" and the password "Flintstone."
Follow the myCrashpadCrasher pattern to enable Crashpad in your application.
Add the following includes:
Copy the initializeCrashpad
and GetCrashpadHandlerPath
methods from the BugSplat sample. The Crashpad url
and parameters format
, database
, product
and version
are required to upload crash reports to BugSplat. You can optionally specify values for the parameters user
, list_annotations
, and key
which will be tracked with each crash report.
Call initializeCrashpad
using your own parameters for the BugSplat dbName
, appName
, and appVersion
.
Link your application with the appropriate version of the Crashpad libraries client.lib
, base.lib
, andutil.lib
. BugSplat supplies builds for Debug/Release (x86) and Debug_x64/Release_x64 versions of the Crashpad libraries.
Once you have symbol-upload downloaded or installed, modify the following command to suit your needs.
Trigger a crash in your application. The crash report should be available immediately on the BugSplat website.
Compiler optimizations can cause a mismatch between the line numbers in crash reports and the actual line numbers in your code. BugSplat recommends turning off compiler optimizations to ensure that the line numbers in your crash reports match the line numbers in your code. To turn off optimizations in Visual Studio, right-click your project and navigate to Properties > C/C++ > Optimization > Optimization, and set the value to Disabled (/Od).
You will need to generate and upload .sym
files to BugSplat to generate function names and line numbers in the stack traces of your crash reports. BugSplat's tool can be used conveniently to generate and upload .sym
files with a single terminal command. Download a copy of symbol-upload from or install it via .
The BugSplat database for your crash reports is created on the page in Settings. Typically, you will create a new database for each major release of your product.