Skip to content

flutter: win/linux supported native symbols #12536

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

Closed
bruno-garcia wants to merge 4 commits into from
Closed

flutter: win/linux supported native symbols #12536

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
298efe9
flutter: win/linux supported native symbols
bruno-garcia Feb 2, 2025
f0a06dc
Apply suggestions from code review
bruno-garcia Feb 2, 2025
a83e30e
remove win/linux not supported with obfuscation
vaind Feb 4, 2025
cc3103b
Update upload-debug.mdx
bruno-garcia Feb 19, 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
20 changes: 6 additions & 14 deletions docs/platforms/flutter/upload-debug.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ We offer a range of methods to provide Sentry with debug symbols so that you can

With default settings, complete stack traces are available in your Dart error, out of the box, unless you use [`split-debug-info`](https://flutter.dev/docs/perf/app-size#reducing-app-size) and [`obfuscate`](https://flutter.dev/docs/deployment/obfuscate). In those cases, you need to upload the debug information files generated by the `flutter` build, so Sentry can show you proper stack traces.

<Alert>

For Flutter Desktop (Windows/Linux) `split-debug-info` and `obfuscate` flags are not supported yet. See this [issue](https://github.com/getsentry/sentry-dart/issues/433).

</Alert>

Errors raised from the native layer in Flutter apps require certain debug information files to be uploaded. For example, an Android app can use `proguard` for minification and obfuscation. And when using NDK, dwarf debug files need to be uploaded. Flutter Web requires sourcemaps and iOS apps also require dwarf debug information files.

## Sentry Dart Plugin
Expand Down Expand Up @@ -94,11 +88,15 @@ For a standard build:
- `flutter build apk`
- `flutter build ios`
- `flutter build macos`
- `flutter build windows`
- `flutter build linux`

For an obfuscated build:
For an [obfuscated build](https://docs.flutter.dev/deployment/obfuscate):
- `flutter build apk --obfuscate --split-debug-info=<output-directory>`
- `flutter build ios --obfuscate --split-debug-info=<output-directory>`
- `flutter build macos --obfuscate --split-debug-info=<output-directory>`
- `flutter build windows --obfuscate --split-debug-info=<output-directory>`
- `flutter build linux --obfuscate --split-debug-info=<output-directory>`

<Alert>

Expand Down Expand Up @@ -157,16 +155,10 @@ You will need to upload the following files:

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. [Learn how to upload the dSYM files](/platforms/apple/dsym/).

### Android
### Android, Windows and Linux

See our docs on uploading [Debug Information Files](/cli/dif/#uploading-files) manually with the Sentry CLI.

### Android NDK

See our docs on uploading [Debug Information Files](/cli/dif/#uploading-files) manually with the Sentry CLI.

If you're using a version of `sentry_flutter` earlier than 5.1, native symbolication on Android requires a specific configuration. Refer to [Troubleshooting](/platforms/flutter/troubleshooting/#native-symbolication-on-android) for more information.

<Alert>

Sentry's Flutter SDK doesn't currently support the `uploadNativeSymbols` flag from the [Sentry Gradle Plugin](/platforms/android/configuration/gradle/).
Expand Down