Skip to content

docs(sentry-dio): improve addSentry method documentation #2912

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 2 commits into from
May 7, 2025
Merged

docs(sentry-dio): improve addSentry method documentation #2912

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e0bb18
docs(sentry-dio): improve `addSentry` method documentation with usage…
tsinis May 6, 2025
1d0f39d
fix(style): dartdoc dart format .
tsinis May 6, 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
13 changes: 11 additions & 2 deletions dio/lib/src/sentry_dio_extension.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,17 @@ import 'version.dart';
extension SentryDioExtension on Dio {
/// Adds support for automatic spans for http requests,
/// as well as request and response transformations.
/// This must be the last initialization step of the [Dio] setup, otherwise
/// your configuration of Dio might overwrite the Sentry configuration.
/// This must be the last initialization step of the [Dio] setup. Sentry will
/// use your configuration, so update it first, and call `addSentry()` as the
/// last step. Since Sentry does not override any user configuration, it then
/// uses whatever transformer, adapter, etc., you configured [Dio] to use.
///
/// ```dart
/// final dio = Dio();
/// dio.transformer = YourCustomTransformer();
/// dio.httpClientAdapter = YourCustomHttpClientAdapter();
/// dio.addSentry();
/// ```
///
/// You can also configure specific HTTP response codes to be considered
/// as a failed request. In the following example, the status codes 404 and 500
Expand Down
Loading