BugSnag is now Insight Hub – we're making some changes to how the product looks, but this won't impact the way you use BugSnag or any of your integrations.
Upload Breakpad symbols
BugSnag supports symbolicating stack traces using Breakpad symbol files to show a full stack trace with methods, file paths, and line numbers.
If your app contains native libraries (aside from Electron and its helper libraries), you will need to generate and upload symbols for each library and supported platform to see full stack traces for native crashes.
For installation instructions for the BugSnag CLI, please see our Installation guide.
Overview
The breakpad command uploads symbol files (.sym) generated by Breakpad’s dump_syms tool to the Breakpad Symbol Upload API endpoint – see the API docs for more details on how to generate these from your app.
Example usage
To upload symbol files, specify your BugSnag API key and the path to your symbol files or directory containing them:
$ bugsnag-cli upload breakpad path/to/symbols/ --api-key=YOUR_API_KEY
Available options
API key (--api-key)
The BugSnag API key for the application.
You can find your API key in Project Settings from your BugSnag dashboard.
Code file (--code-file)
The basename of the module.
Cpu arch (--cpu-arch)
The CPU architecture that the module was built for.
Debug file (--debug-file)
The basename of the debug file.
Debug identifier (--debug-identifier)
The debug file’s identifier.
Dry run (--dry-run)
Performs a dry-run of the command without sending any information to BugSnag.
Fail on upload error (--fail-on-upload-error)
Stops the upload when a file fails to upload successfully.
Log level (--log-level)
Sets the level of logging to debug, info, warn or fatal.
Default: info.
Os name (--os-name)
The name of the operating system that the module was built for.
Overwrite (--overwrite)
Whether to ignore and overwrite existing uploads with same identifier, rather than failing if a matching file exists.
Port (--port)
The port number for the BugSnag upload server.
Default: 443.
Product name (--product-name)
The product name.
Project root (--project-root)
The path to strip from the beginning of source file names referenced in stacktraces on the BugSnag dashboard.
Default: the root directory if the command has detected one, otherwise it’s empty.
Retries (--retries)
The number of retry attempts before failing an upload request.
Default: 0.
Timeout (--timeout)
The number of seconds to wait before failing an upload request.
Default: 300.
Upload API root URL (--upload-api-root-url)
The upload server hostname, optionally containing port number.
For use in BugSnag On-premise configurations. The command will append the appropriate path to access the correct upload endpoint.
Default: https://upload.bugsnag.com.
Verbose (--verbose)
Sets the level of the logging to its highest.
This is the equivalent of setting the log level to debug.
Version name (--version-name)
The version of the application.