Skip to content

Add instruction how force dSYM generation in Unreal Engine for Mac/iOS builds #13795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 22, 2025
Merged

Add instruction how force dSYM generation in Unreal Engine for Mac/iOS builds #13795

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf8bbbc
Add instruction how to generate dSYM for Mac/iOS
tustanivsky May 22, 2025
9bc142a
Move Xcode build phase to alert
tustanivsky May 22, 2025
bb6cc5a
Update docs/platforms/unreal/configuration/debug-symbols/index.mdx
tustanivsky May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/platforms/unreal/configuration/debug-symbols/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,21 @@ To upload debug symbols to Sentry manually, run `sentry-cli` through the command
```bash
sentry-cli --auth-token ___ORG_AUTH_TOKEN___ debug-files upload --org ___ORG_SLUG___ --project ___PROJECT_SLUG___ PATH_TO_SYMBOLS
```

## Debug symbols for macOS and iOS

Sentry requires [_dSYM files_](/platforms/unreal/data-management/debug-files/file-formats/#mach-o-and-dsym) to fully symbolicate your stack traces for macOS/iOS games. To ensure that the debug symbols are generated and can be processed by the Sentry Unreal plugin during the execution of `PostBuildSteps`, add the following build settings to your project `.Target.cs` file:

```csharp
// For Mac
MacPlatform.bUseDSYMFiles = true;

// For iOS
IOSPlatform.bGeneratedSYM = true;
```

<Alert>

Unreal Engine 5.3 and newer supports [Modernized Xcode Workflow](https://dev.epicgames.com/documentation/en-us/unreal-engine/using-modern-xcode-in-unreal-engine-5.3-and-newer) which aligns more closely with standard Apple development practices. In this case, symbol upload can be handled during the custom [Xcode Build Phase](https://docs.sentry.io/platforms/apple/guides/macos/dsym/#xcode-build-phase).

</Alert>