Debug Symbols
Debug symbols provide information that Sentry displays on the Issue Details page to help you triage an issue. We offer a range of methods to provide Sentry with debug symbols.
When to Upload
With default settings, complete stack traces are available in your Dart error, out of the box, unless you use split-debug-info
and 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.
For Flutter Desktop (Windows/macOS/Linux) split-debug-info
and obfuscate
flags are not supported yet. See this issue.
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
Try out the Sentry Dart Plugin, which uploads debug symbols automatically for you, or follow the manual steps below.
Uploading for iOS and macOS
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.
If you use the split-debug-info
and obfuscate
flags, you need to upload the *.dSYM
files instead of the *.symbols
files generated by the Flutter build. The *.dSYM
files are located in the build
folder of your project and not the given split-debug-info
folder.
Uploading for Android NDK
If you are using sentry_flutter
version earlier than 5.1, native symbolication on Android requires a specific configuration. For good symbolication, set android:extractNativeLibs="true"
in your AndroidManifest.xml
file or android.bundle.enableUncompressedNativeLibs=false
for Android App Bundle in your gradle.properties
file.
If you use the Android NDK, you must upload files manually using our CLI.
Sentry's Flutter SDK doesn't currently support the uploadNativeSymbols
flag from the Sentry Gradle Plugin.
Uploading with ProGuard
To use ProGuard with Sentry, upload the Android Proguard/R8 mapping files by either the recommended method of using our Gradle integration or manually by using sentry-cli.
Uploading Source Maps for Flutter Web
You can also use our CLI to upload source maps for Flutter Web.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- pub:sentry_flutter
- Version:
- 7.7.0
- Repository:
- https://github.com/getsentry/sentry-dart