Skip to content

Fix and extend documentation. #271

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 1 commit into from
May 5, 2025
Merged

Fix and extend documentation. #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 26 additions & 16 deletions doc/leak_tracking/DETECT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,9 @@ class InstrumentedDisposable {

## See leaks in a running application (experimental)

1. Add [leak_tracker](https://pub.dev/packages/leak_tracker) to `dependencies` in `pubspec.yaml`.
1. Add `leak_tracker: any` to `dependencies` in `pubspec.yaml`.

2. Before `runApp` invocation, enable leak tracking

3. For Flutter applications, connect to
2. Before `runApp` invocation, enable leak tracking and connect to
the Flutter memory allocation events:

```dart
Expand Down Expand Up @@ -135,25 +133,37 @@ the Flutter memory allocation events:
create and dispose any Flutter disposable (for example
`FocusNode`), and store the instance in a global array.

To track notGCed leaks, you
NOTE: To track notGCed leaks (experimental feature), you need to enable them:

```
LeakTracking.phase = PhaseSettings(
ignoredLeaks: IgnoredLeaks(experimentalNotGCed: IgnoredLeaksSet()),
);
```

5. Troubleshooting tips:

a. Get the details of the leaks by collecting them
on a button click or on some other event. Then either
analyze the leaks programmatically or print them to the console:
a. To analyze the leaks programmatically run:

```
final leaks = await LeakTracking.collectLeaks();
print(leaks.toYaml(phasesAreTests: false));
```
```
final leaks = await LeakTracking.collectLeaks();
print(leaks.toYaml(phasesAreTests: false));
```

b. To start collecting creation call stack, update `phase`:

```dart
LeakTracking.phase = PhaseSettings(
leakDiagnosticConfig: LeakDiagnosticConfig(collectStackTraceOnStart: true),
);
```

b. To declare all not disposed objects as leaks, invoke `LeakTracking.declareNotDisposedObjectsAsLeaks()`
c. To declare all not disposed objects as leaks, invoke `LeakTracking.declareNotDisposedObjectsAsLeaks()`

c. To add debugging information to an object's record, invoke
`LeakTracking.dispatchObjectTrace(theObject, <some debugging information>)`
d. To add debugging information to an object's record, invoke
`LeakTracking.dispatchObjectTrace(theObject, <some debugging information>)`

d. To analyze all tracked objects, invoke `LeakTracking.tracked()`
e. To analyze all tracked objects, invoke `LeakTracking.tracked()`

## Limitations

Expand Down