Skip to content

Commit 5ebcf67

Browse files
feat(unity): Automated symbol upload (#4462)
Co-authored-by: Isabel <[email protected]>
1 parent 70b514c commit 5ebcf67

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/platforms/unity/native-support.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,21 @@ You can opt out of native support by unchecking `iOS Native Support` and `Androi
1818

1919
## Debug Symbols
2020

21-
Sentry requires [debug information files](/platforms/android/data-management/debug-files/) to symbolicate your crash logs. To upload these, the Unity SDK relies on the [sentry-cli](/product/cli/). We included the executables for Windows, macOS, and Linux inside the Sentry SDK package.
22-
23-
### Android
21+
Sentry requires [debug information files](/platforms/android/data-management/debug-files/) to symbolicate your crash logs. The Unity SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/product/cli/). We've included the executables for Windows, macOS, and Linux inside the Unity SDK package.
2422

2523
The automated debug symbols upload is enabled by default but requires configuration. Go to **Tools > Sentry > Editor** to enter the [Auth Token](https://sentry.io/api/), Org Slug, and the Project Name. Note that the Unity SDK creates a file at `Assets/Plugins/Sentry/SentryCliOptions.asset` to store the configuration, that should not be made publicly available.
2624

27-
### iOS
25+
### iOS - dSYM and Bitcode
2826

2927
Debug information files on the iOS platform are called dSYM, and the way to obtain them differs depending on whether `Enable Bitcode` is set to `true` in your Xcode project.
3028

31-
With Bitcode disabled, make sure the `Debug Information Format` is set to `DWARF with dSYM file`. When building the game, Xcode will then place the dSYM folders together with the build output and you can run the sentry-cli command there. By default the output path will look similar to: _~/Library/Developer/Xcode/DerivedData/BUILD_ID/Build/Products/BUILD_TYPE/_.
29+
For Sentry to symbolicate your crash logs and with `bitcode` enabled, we need two types of files:
30+
1. `dSYM` files available only **after** App Store Connect finishes processing the build
31+
2. `BCSymbolMap` files that are created during the archiving process
32+
33+
The automated symbol upload will take care of the `BCSymbolMap` files by processing them during the archiving process. To provide the dSYM files to Sentry, you can either set up the [App Store Connect Integration](/platforms/apple/guides/ios/dsym/#bitcode-appstore) so Sentry can fetch them for you or download and then upload them [manually using sentry-cli](/platforms/apple/guides/ios/dsym/#bitcode-sentrycli).
3234

33-
If you have Bitcode enabled, please refer to our [iOS documentation](/platforms/apple/guides/ios/dsym/).
35+
With `bitcode` disabled, the automated symbols upload will pick up the `dSYM` files at the end of the build process without further action required.
3436

3537
### Manual Upload Using sentry-cli
3638

0 commit comments

Comments
 (0)