A Dart Build Plugin that uploads debug symbols for Android, iOS/macOS and source maps for Web to Sentry via sentry-cli.
For doing it manually, please follow our docs.
In your pubspec.yaml, add sentry_dart_plugin as a new dev dependency.
dev_dependencies:
sentry_dart_plugin: ^3.0.0The flutter build apk, flutter build ios (or macos) or flutter build web is required before executing the sentry_dart_plugin plugin, because the build spits out the debug symbols and source maps.
dart run sentry_dart_pluginThis tool comes with a default configuration. You can configure it to suit your needs.
By default the plugin will look for the Sentry configuration in the pubspec.yaml and sentry.properties file.
If a Sentry value does not exist in pubspec.yaml, the plugin will fallback to sentry.properties file.
If a value exists in both, the pubspec.yaml takes precedence over the sentry.properties values.
Environment and argument variables will take precedence over the file based ones.
Add sentry: configuration at the end of your pubspec.yaml file:
sentry:
upload_debug_symbols: true
upload_source_maps: false
upload_sources: false
legacy_web_symbolication: false
project: ...
org: ...
auth_token: ...
url: ...
url_prefix: ...
wait_for_processing: false
log_level: error # possible values: trace, debug, info, warn, error
release: ...
dist: ...
build_path: ...
web_build_path: ...
symbols_path: ...
# Path to the Dart obfuscation map (opt-in)
# Example generation flags:
# flutter build apk --obfuscate --split-debug-info=symbols \\
# --extra-gen-snapshot-options=--save-obfuscation-map=build/app/obfuscation.map.json
# Then set the path below to the generated obfuscation map file
dart_symbol_map_path: build/app/obfuscation.map.json
commits: auto
ignore_missing: trueYou can also override or extend your file based configuration by passing the parameters as arguments
in the format --sentry-define=<KEY>=<VALUE>. They take precedence over your file based parameters,
but not over the alternative environment variables.
dart run sentry_dart_plugin --sentry-define=release=app-internal-test@0.0.1Create a sentry.properties file at the root of your project:
upload_debug_symbols=true
upload_source_maps=false
upload_sources=false
legacy_web_symbolication=false
project=...
org=...
auth_token=...
url=...
wait_for_processing=false
log_level=error # possible values: trace, debug, info, warn, error
release=...
dist=...
build_path: ...
web_build_path=...
symbols_path=...
commits=auto
ignore_missing=true| Configuration Name | Description | Default Value And Type | Required | Alternative Environment variable |
|---|---|---|---|---|
| upload_debug_symbols | Enables or disables the automatic upload of debug symbols | true (boolean) | no | - |
| upload_source_maps | Enables or disables the automatic upload of source maps | false (boolean) | no | - |
| upload_sources | Does or doesn't include the source code of native code | false (boolean) | no | - |
| legacy_web_symbolication | Uses legacy symbolication method for Flutter Web instead of Debug IDs | false (boolean) | no | - |
| project | Project's name | e.g. sentry-flutter (string) | yes | SENTRY_PROJECT |
| org | Organization's slug | e.g. sentry-sdks (string) | yes | SENTRY_ORG |
| auth_token | Auth Token | e.g. 64 random characteres (string) | yes | SENTRY_AUTH_TOKEN |
| url | URL | e.g. https://mysentry.invalid/ (string) | no | SENTRY_URL |
| url_prefix | URL prefix for JS source maps | e.g. ~/app/ (string) | no | - |
| wait_for_processing | Wait for server-side processing of uploaded files | false (boolean) | no | - |
| log_level | Configures the log level for sentry-cli | warn (string) | no | SENTRY_LOG_LEVEL |
| release | The release version for source maps, it should match the release set by the SDK | name@version from pubspec (string) | no | SENTRY_RELEASE |
| dist | The dist/build number for source maps, it should match the dist set by the SDK | the number after the '+' char from 'version' pubspec (string) | no | SENTRY_DIST |
| build_path | The build folder of debug files for upload | build (string) |
no | - |
| web_build_path | The web build folder of debug files for upload relative to build_path | web (string) |
no | - |
| symbols_path | The directory containing debug symbols (i.e. the --split-debug-info= parameter value you pass to flutter build) |
. (string) |
no | - |
| dart_symbol_map_path | Absolute or relative path to a Dart obfuscation map file to upload. This allows symbolication of Flutter issue titles for Android and iOS. The map file is generated by adding the following arguments to your Flutter build command: --extra-gen-snapshot-options=--save-obfuscation-map=<path>. |
null (string) | no | - |
| commits | Release commits integration | auto (string) | no | - |
| ignore_missing | Ignore missing commits previously used in the release | false (boolean) | no | - |
| bin_dir | The folder where the plugin downloads the sentry-cli binary | .dart_tool/pub/bin/sentry_dart_plugin (string) | no | - |
| bin_path | Path to the sentry-cli binary to use instead of downloading. Make sure to use the correct version. | null (string) | no | - |
| sentry_cli_cdn_url | Alternative place to download sentry-cli | https://downloads.sentry-cdn.com/sentry-cli (string) | no | SENTRYCLI_CDNURL |
| sentry_cli_version | Override the sentry-cli version that should be downloaded. | (string) | no | - |
Starting with version 3.0.0, the plugin now automatically embeds Debug IDs into your generated source maps for Flutter Web by default. This makes symbolication of Flutter Web stack traces far more stable and reliable.
Important: Debug IDs only work with Sentry Flutter SDK 9.1.0 or newer. If you're using an older version of the Sentry Flutter SDK (9.0.0 or below), you have two options:
- Recommended: Upgrade to Sentry Flutter SDK 9.1.0 or newer to use Debug IDs
- Legacy mode: Add the following to your configuration to use the classic symbolication method:
sentry:
legacy_web_symbolication: truePer default, the release is build from pubspec.yaml's name, version & build: name@version+build. The build number, if present, is used as the dist parameter.
You can override these values by providing a release and dist through the plugin config, or through environmental values. The latter have precedence over the former.
A custom dist value will also be used as the build number.
If provided, the plugin will take your release and dist values without further mutating them. Make sure you configure everything as outlined in the release docs of sentry-cli.
If you're publishing your app on the web and it's not deployed at the root of your URL, you need to configure a url_prefix and update your stack frames.
Add the prefix to your pubspec.yaml in addition to your other configurations. Make sure that you have upload_source_maps enabled:
sentry:
upload_source_maps=true
url_prefix: ~/your_prefix/The absolute path of your stack frames also needs to include the same prefix so that the source maps can be found for deobfuscation. Below is an example of how to update the stack frame's absolute path to include the prefix using the beforeSend hook:
options.beforeSend = (event, hint) async {
final exceptions = event.exceptions?.map((exception) {
final stackTrace = exception.stackTrace;
if (stackTrace != null) {
final frames = stackTrace.frames.map((frame) {
const baseUrl = 'https://your-domain.com/';
final modifiedAbsPath = frame.absPath?.replaceFirst(
baseUrl,
'${baseUrl}your_prefix/',
);
return frame.copyWith(absPath: modifiedAbsPath);
}).toList();
return exception.copyWith(
stackTrace: SentryStackTrace(frames: frames),
);
}
return exception;
}).toList();
return event.copyWith(exceptions: exceptions ?? []);
};Don't forget to specify the prefix path when building for the web and also build with --source-maps:
flutter build web --base-href=/your_prefix/ --source-mapsSentry's auth_token requires the project:releases or project:write scope, See docs.
For the commits feature, Sentry's auth_token also requires the org:read scope, See docs.
Dart's --obfuscate option is required to be paired with --split-debug-info to generate a symbol map, See docs.
The --split-debug-info option requires setting a output directory, the directory must be an inner folder of the project's folder, See docs.
Flutter's build web command requires setting the --source-maps parameter to generate source maps, See Issue
If you opt into uploading a Dart obfuscation map (dart_symbol_map_path), ensure you build with both --obfuscate and --extra-gen-snapshot-options=--save-obfuscation-map=<path>. The map path you configure must point to the generated file.
If a previous release could not be found in the git history, please make sure you set ignore_missing: true in the configuration if you want to ignore such errors, See Issue