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
feat(dart): Add info about dart_symbol_map_path (#15302)
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
This PR focuses on documenting a new feature for Flutter
## IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [x] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@@ -52,12 +55,17 @@ For more information, read the [Sentry Dart Plugin README](https://github.com/ge
52
55
53
56
Before running the plugin, build your Flutter application with one of the following commands. Obfuscated is encouraged for production builds, and will make uploading debug symbols necessary to get readable stack traces.
54
57
58
+
<Alert>
59
+
The `--extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json` option is required to generate the symbol map file which is used to make the obfuscated Flutter issue titles readable on iOS and Android.
60
+
Make sure to set the `dart_symbol_map_path` option in your `pubspec.yaml` file to the path of the `obfuscation.map.json` file.
flutter build windows --obfuscate --split-debug-info=<output-directory> --extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json
68
+
flutter build linux --obfuscate --split-debug-info=<output-directory> --extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json
61
69
```
62
70
63
71
```bash {tabTitle: Flutter Web}
@@ -83,7 +91,7 @@ If you don't obfuscate your build, the plugin won't upload debug symbols. Additi
83
91
84
92
## Android ProGuard Integration
85
93
86
-
If you have ProGuard (`minifyEnabled`) enabled, you must upload Android Proguard/R8 mapping files. You have two options:
94
+
If you have ProGuard (`minifyEnabled`) enabled and you want to see proper native Android stacktraces, you must upload Android Proguard/R8 mapping files. You have two options:
87
95
88
96
1.**Use the Sentry Android Gradle Plugin (Recommended)**
89
97
@@ -125,6 +133,7 @@ The following table lists all available configuration options for the Sentry Dar
125
133
|`upload_debug_symbols`| boolean |`true`| Enables or disables automatic upload of debug symbols ||
126
134
|`upload_source_maps`| boolean |`false`| Enables or disables automatic upload of source maps ||
127
135
|`upload_sources`| boolean |`false`| Enables or disables source code upload ||
136
+
|`dart_symbol_map_path`| string || Absolute or relative path to the Dart symbol map file used to make obfuscated Flutter issue titles readable on iOS and Android ||
128
137
|`url`| string || The URL of your Sentry instance |`SENTRY_URL`|
129
138
|`url_prefix`| URL prefix for JS source maps | e.g. ~/app/ (string) | no | - |
130
139
|`wait_for_processing`| boolean |`false`| Whether to wait for server-side processing of uploaded files ||
@@ -52,12 +55,17 @@ For more information, read the [Sentry Dart Plugin README](https://github.com/ge
52
55
53
56
Before running the plugin, build your Flutter application with one of the following commands. Obfuscated is encouraged for production builds, and will make uploading debug symbols necessary to get readable stack traces.
54
57
58
+
<Alert>
59
+
The `--extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json` option is required to generate the symbol map file which is used to make the obfuscated Flutter issue titles readable on iOS and Android.
60
+
Make sure to set the `dart_symbol_map_path` option in your `pubspec.yaml` file to the path of the `obfuscation.map.json` file.
flutter build windows --obfuscate --split-debug-info=<output-directory> --extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json
68
+
flutter build linux --obfuscate --split-debug-info=<output-directory> --extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json
61
69
```
62
70
63
71
```bash {tabTitle: Flutter Web}
@@ -125,6 +133,7 @@ The following table lists all available configuration options for the Sentry Dar
125
133
|`upload_debug_symbols`| boolean |`true`| Enables or disables automatic upload of debug symbols ||
126
134
|`upload_source_maps`| boolean |`false`| Enables or disables automatic upload of source maps ||
127
135
|`upload_sources`| boolean |`false`| Enables or disables source code upload ||
136
+
|`dart_symbol_map_path`| string || Absolute or relative path to the Dart symbol map file used to make obfuscated Flutter issue titles readable on iOS and Android ||
128
137
|`url`| string || The URL of your Sentry instance |`SENTRY_URL`|
129
138
|`url_prefix`| URL prefix for JS source maps | e.g. ~/app/ (string) | no | - |
130
139
|`wait_for_processing`| boolean |`false`| Whether to wait for server-side processing of uploaded files ||
0 commit comments