Skip to content

Document flutter auto transaction idle time parameter and trimming #4618

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 3 commits into from
Jan 20, 2022
Merged

Document flutter auto transaction idle time parameter and trimming #4618

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ae62eb
Document idle time param and trimming
Jan 20, 2022
6a05ee8
Update src/platforms/flutter/common/performance/instrumentation/autom…
marandaneto Jan 20, 2022
d43dfd9
Update src/platforms/flutter/common/performance/instrumentation/autom…
marandaneto Jan 20, 2022
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
15 changes: 13 additions & 2 deletions ...tforms/flutter/common/performance/instrumentation/automatic-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For more information see our [SentryHttpClient integration](/platforms/dart/usag

<Note>

Supported in Sentry's Dart SDK version `6.3.0-beta.1` and above.
Supported in Sentry's Dart SDK version `6.3.0-beta.3` and above.

</Note>

Expand Down Expand Up @@ -62,10 +62,21 @@ The SDK sets the span `operation` to `navigation` and the `name` to the one prov

Transactions will be bound to the scope if no other transaction is currently bound to it.

The started transactions will idle for a fixed amount of time, for which the default is `three seconds`.
The started transactions will idle for a fixed amount of time, for which the default is `three seconds`. You can also change this by setting `autoFinishAfter` in the navigators constuctor.

```dart
import 'package:sentry_flutter/sentry_flutter.dart';

/// Change how long navigation transactions idle before being finished
SentryNavigatorObserver(
autoFinishAfter: Duration(seconds: 5)
)
```

Child spans started will be attached to the transaction. If they run longer than the idle time, the transaction will be extended and finished when all its children are complete.

If children are finished before the idle timeout, the transaction end will be trimmed, and its end time will be set to the last child end time.

You can also opt out of this behaviour by setting `enableAutoTransactions` to false in the `SentryNavigatorObserver` constructor. You might do this when you only want to use navigation breadcrumbs, which can be enabled by setting the constructor parameter `setRouteNameAsTransaction` to `true`.

```dart
Expand Down