dsyms

dSYMs command

Upload dSYM files to Datadog to symbolicate your crash reports.

This command runs only in macOS.

Usage

Setup

You need to have DATADOG_API_KEY in your environment.

# Environment setup
export DATADOG_API_KEY="<API KEY>"

It is possible to configure the tool to use Datadog EU by defining the DATADOG_SITE environment variable to datadoghq.eu. By default the requests are sent to Datadog US.

It is also possible to override the full URL for the intake endpoint by defining the DATADOG_DSYM_INTAKE_URL environment variable.

Commands

upload

This command will upload all dSYM files in the given directory. If your app has BITCODE enabled, more info in Bitcode section.

To upload the dSYM files in your Derived Path, this command should be run:

datadog-ci dsyms upload ~/Library/Developer/Xcode/DerivedData/

In addition, some optional parameters are available:

• --max-concurrency (default: 20): number of concurrent upload to the API.
• --dry-run (default: false): it will run the command without the final step of upload. All other checks are performed.

Bitcode

With bitcode enabled, you should download your app's dSYM files from App Store Connect. They come in the form of a zip file, named appDsyms.zip. In that case, you can run datadog-ci by pointing to the zip file.

datadog-ci dsyms upload ~/Downloads/appDsyms.zip

End-to-end testing process

To verify this command works as expected, you can trigger a test run and verify it returns 0:

export DATADOG_API_KEY='<API key>'

// at this point, build any project in Xcode so that it produces dSYM files in Derived Data path
// assuming your Derived Data path is ~/Library/Developer/Xcode/DerivedData/

yarn launch dsyms upload ~/Library/Developer/Xcode/DerivedData/

Successful output should look like this:

Starting upload with concurrency 20. 
Will look for dSYMs in /Users/mert.buran/Library/Developer/Xcode/DerivedData
Uploading dSYM with 00000-11111-00000-11111 from /path/to/dsym/file1.dSYM
Uploading dSYM with 00000-22222-00000-22222 from /path/to/dsym/file2.dSYM
Uploading dSYM with 00000-33333-00000-33333 from /path/to/dsym/file3.dSYM
...

Command summary:
✅ Uploaded 5 dSYMs in 8.281 seconds.
✨  Done in 10.71s.

Further reading

Additional helpful documentation, links, and articles:

• Learn about iOS Crash Reporting and Error Tracking