You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/platforms/apple/common/dsym.mdx
+56-4Lines changed: 56 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,62 @@ title: Uploading Debug Symbols
6
6
tags: []
7
7
---
8
8
9
-
Sentry requires a dSYM upload to symbolicate your crash logs. The symbolication process unscrambles Apple’s crash logs to reveal the function, file names, and line numbers of the crash. Upload the dSYM file using either [sentry-cli](https://github.com/getsentry/sentry-cli) or the [Fastlane](https://fastlane.tools/) action.
9
+
Sentry requires a dSYM upload to symbolicate your crash logs. The symbolication process unscrambles Apple’s crash logs to reveal the function, file names, and line numbers of the crash. Upload the dSYM file using either [sentry-cli](https://github.com/getsentry/sentry-cli), the [Fastlane](https://fastlane.tools/) action, or set up the Sentry [App Store Connect](#bitcode-appstore) integration for Bitcode builds.
10
10
11
11
## With Bitcode {#dsym-with-bitcode}
12
12
13
-
If [Bitcode](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/AppThinning/AppThinning.html#//apple_ref/doc/uid/TP40012582-CH35-SW2)**is enabled** in your project, you will have to upload the dSYM to Sentry **after** it has finished processing in iTunesConnect. We also recommend using the latest Xcode version for submitting your build. The dSYM can be downloaded either with [Fastlane](#bitcode-fastlane) or with [sentry-cli](#bitcode-sentrycli).
13
+
If [Bitcode](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/AppThinning/AppThinning.html#//apple_ref/doc/uid/TP40012582-CH35-SW2)**is enabled** in your project, dSYM files will only be available **after** builds have finished processing in App Store Connect. We recommend using the latest Xcode version for submitting your build.
14
+
15
+
Sentry can fetch dSYM files automatically as they become available from App Store Connect when setting up the [App Store Connect](#bitcode-appstore) integration.
16
+
17
+
Alternatively, the dSYM files can be downloaded either with [Fastlane](#bitcode-fastlane) or manually, and uploaded with [sentry-cli](#bitcode-sentrycli).
18
+
19
+
### Using App Store Connect {#bitcode-appstore}
20
+
21
+
_NOTE_: This feature will be available as an early access preview soon.
22
+
23
+
When you use the App Store Connect integration, Sentry will automatically discover and fetch dSYM files for Bitcode builds as they become available on App Store Connect. These dSYM files however contain obfuscated symbol names and paths. An additional BCSymbolMap file needs to be uploaded to provide properly symbolicated crash reports. These BCSymbolMap files can be uploaded using either [sentry-cli](#symbolmap-sentrycli) or [Fastlane](#symbolmap-fastlane).
24
+
25
+
To configure the integration, go to **[Project] > Settings > Debug Files** and add App Store Connect as a new "Custom Repository". Note that setting up the integration will currently result in two identical audit entries being created.
26
+
27
+
Free tiers will be able to set up one App Store Connect source per project. Take a look at our [plans](https://sentry.io/pricing/) or contact [[email protected]](mailto:[email protected]) if more than one App Store Connect source is required.
28
+
29
+
Setting up App Store Connect currently requires two separate credentials.
30
+
31
+
**App Store Connect API Key**:
32
+
33
+
Follow the documentation on [Creating API Keys for App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api) and provide the _Issuer_, _Key ID_, and _Private Key_. The API Key needs to have the _Developer_ role in order to fetch build details.
34
+
35
+
**iTunes Credentials**:
36
+
37
+
An iTunes user and password are required, in addition to the normal App Store Connect API Key, due to limitations of the App Store Connect API. The App Store Connect API Key alone will only allow detection of new builds; an iTunes user is required to fetch the associated dSYM files.
38
+
39
+
[Create a new Apple ID](https://support.apple.com/en-us/HT204316) specifically for this integration and provide its credentials. The user needs to have the _Developer_ role in the appropriate App Store Organization.
40
+
41
+
<Alertlevel="warning">
42
+
43
+
We highly recommend that you create a dedicated iTunes user account for the purpose of this integration, and that you **not** use a regular user account.
44
+
45
+
Using the configured iTunes account on a different device will disrupt Sentrys ability to use it in order to download dSYM files.
46
+
47
+
</Alert>
48
+
49
+
These credentials will need to be verified by a two-factor authentication token that you can choose to have sent by SMS.
50
+
51
+
**Re-authentication**
52
+
53
+
The iTunes credentials and two-factor authentication are short-lived and need to be refreshed on a regular basis. Sentry will prompt users to re-authenticate once the iTunes credentials expire.
54
+
55
+
#### Upload BCSymbolMaps using Fastlane {#symbolmap-fastlane}
56
+
57
+
As dSYM download will be handled by sentry, it is not necessary to use the _download_dsyms_ or _sentry_upload_dsym_ commands.
58
+
Instead, use the _sentry_upload_dif_ command to upload the BCSymbolMap.
59
+
60
+
When using the _upload_to_testflight_ action, it is recommended to pass the _skip_waiting_for_build_processing_ parameter to speed up the action.
61
+
62
+
#### Upload BCSymbolMaps using `sentry-cli`{#symbolmap-sentrycli}
63
+
64
+
The `sentry-cli upload-dif` command will automatically find and upload all _BCSymbolMap_ files, given the path to the `.xcarchive`.
14
65
15
66
### Using Fastlane {#bitcode-fastlane}
16
67
@@ -114,8 +165,9 @@ fi
114
165
115
166
3. If you are using Xcode 10 or newer, you also need to add the following line to the _Input Files_ section in the _Run Script_ from step 2:
116
167
117
-
[//]: #(Don't use bash here. Clicking the copy button on the code sample with bash)
118
-
[//]: #(removes the leading $.)
168
+
[//]: #"Don't use bash here. Clicking the copy button on the code sample with bash"
Copy file name to clipboardExpand all lines: src/platforms/common/data-management/debug-files/index.mdx
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ supported:
7
7
- native
8
8
- android
9
9
- cocoa
10
+
- apple
10
11
description: "Learn about how debug information files allow Sentry to extract stack traces and provide more information about crash reports for most compiled platforms."
0 commit comments