Upload Breakpad symbol files to allow symbolicate stacktraces within minidump files (generated when using Electron, Breakpad or Crashpad) to show human-readable stacktraces in your dashboard.

If your application uses native libraries (aside from Electron and its helper libraries), you will need to generate and upload symbol files for each library and platform supported to see full stacktraces for native crashes. This can either be done using the POST /breakpad-symbol endpoint directly or using the Breakpads symupload tool.

Generating symbol files

To be able to generate symbol files, firstly download the Breakpad source code (GitHub mirror) and then build the dump_syms tool in the src/tools/{platform} directory.

There is a prebuilt binary for Windows and an Xcode project for macOS.

Run the built dump_syms tool with a path to the native library or generated symbol files. Generated symbol files include *.pdb files on Windows and LLVM debug symbol maps (*.dSYM/**/DWARF/*) files on macOS.

You will need to generate symbol files for each of your native libraries on each of the platforms that you support, including for different CPU architectures.

Linux example

<path/to/dump_syms> <path/to/my/lib> > mylib.sym

macOS example

<path/to/dump_syms> -g <path/to/dsym> -a x86_64 > mylib.sym

Use the -a option if your library is built for contains multiple architectures.

Windows example

<path\to\dump_syms>.exe <\path\to\my\lib>.pdb > mylib.sym

Example cURL

$ curl "https://your.upload.server/breakpad-symbol?api_key=<YOUR_API_KEY>&overwrite=true&project_root=C%3A%5Cworkspace%5Cmy_app"\
    -F symbol_file=@/path/to/symbol/file\
    -F version=1.2.3\
    -F os=windows\
    -F cpu=x86\
    -F debug_file=app.pdb\
    -F code_file=app.exe\
    -F debug_identifier=11111111BBBB3333DDDD555555555555F\
    -F product=MyApp

Using symupload

Breakpad provides a symupload tool for uploading Breakpad symbol files to a target endpoint.

There is a prebuilt binary for Windows and an Xcode project for macOS.

The symupload tool can be used to upload Breakpad symbol files by setting the upload URL to the API endpoint (including the project's API key as a query parameter):

symupload </path/to/symbol/file>\
    "https://your.upload.server/breakpad-symbol?api_key=<YOUR_API_KEY_HERE>&overwrite=true&project_root=C%3A%5Cworkspace%5Cmy_app"