BugSplat Documents

Breakpad breakpad_crashreporting_bugsplat_small

Crash reporting from BugSplat makes it simple to track and analyze the crashes experienced by your users.

Use the crash data collected by BugSplat to prioritize fixes, track defects, and understand the stability of your software.

To learn more about BugSplat sign up for a free trial.

Overview

In a few simple steps, your Breakpad-enabled application can be configured to send crash reports to BugSplat. For more information on Breakpad, see the Breakpad page.

Before starting make sure to clone the Breakpad repo with Google Git.

Configuring Breakpad to send crash reports to BugSplat

  • Configure Breakpad to post crashes to http://database.bugsplat.com/post/bp/crash/postBP.php and make sure to specify your own value for the database portion of the URL, which corresponds to the BugSplat database used to store your crash reports.
    Next, configure the Breakpad POST parameters for the BugSplat application name, application version, and for the crash dump file. The following POST parameters are required:prod – Application name
    ver – Application version
    upload_file_minidump – a multipart form file upload containing the crash dumpThe remaining POST parameters are optional:
    key – Application key, customer-provided data displayed on the All Crash page
    email – user email address
    comments – user provided comments about steps leading to the crashAdditional multipart form file uploads will be added to the crash report. Note total size of the crash posts must be less than 2 MB.
    You can manually upload Breakpad crashes using our test page at {database}.bugsplat.com/post/bp/crash/Native (replace {database} with the name of your BugSplat database). Viewing the source HTML of that page may help with Breakpad configuration.Here’s the input form you should see on that page:

     
    	  
    	  
    	  
    	   
    	
     
    	
     
    

     

  • The BugSplat database for your crash reports is created on the Databases page. Typically, you will create a new database for each major release of your product.
  • Breakpad symbol information must be uploaded to the BugSplat website to get symbolic stack reports. For Windows applications, symbols can be uploaded manually on our Symbols page, or can be sent automatically using the SendPdbs.exe utility. (SendPdbs.exe is part of the BugSplat Native SDK download.) Be certain that the application name and version match exactly with the values specified above. It is also possible to use the Breakpad symupload utility for Windows symbols. However, this is not recommended for Windows executables. For the best call stack resolution, use one of the approaches described above. The Breakpad symupload utility can be pointed at BugSplat using:
    symupload exe_or_dll_file http://database.bugsplat.com/post/bp/symbol/breakpadsymbols.php?appName=MyApp&appVer=version

    Be sure to specify your own values for the database, MyApp, and version parameters.

    On other (non-Windows) operating systems, you must use the Breakpad dump_sym program to create symbol files, and then use the Breakpad symupload program to upload them. The symupload utility can be pointed at BugSplat using:

    symupload symbol_file http://database.bugsplat.com/post/bp/symbol/breakpadsymbols.php?appName=MyApp&appVer=version

    Be sure to specify your own values for the database, MyApp, and version parameters.

    Extracted Breakpad symbols can also be manually uploaded on our Breakpad Symbols page. Don’t use this page to upload Windows .exe or .dll files directly.

    Remember that after each build you must upload new symbol files.

  • The final step is to test your application by forcing a crash. New crash reports will display immediately on the AllCrash page, and uploaded symbols can be seen on the Symbols page.