| # Memory usage tracking and auto-snapshotting |
| |
| This page describes how to configure memory usage tracking. |
| See other information on memory debugging [here](../README.md). |
| |
| Dart and Flutter applications can be configured to automatically |
| trigger memory usage events and, in case of memory overuse, to save |
| memory heap snapshots to hard drive. |
| The snapshots can be later analyzed in DevTools. |
| |
| https://user-images.githubusercontent.com/12115586/234953319-6f864d25-9854-4126-b4d6-8e114b9045ff.mov |
| |
| ## Configure usage tracking |
| |
| Use the function `trackMemoryUsage` to configure usage events and auto-snapshotting. |
| |
| See [example](../examples/autosnapshotting/). |
| |
| We recommend to have auto-snapshotting off by default, with possibility |
| to enable it via command line arguments in case of reported memory issues. |
| |
| ## Analyze snapshots |
| |
| Use [CLI](https://github.com/dart-lang/sdk/tree/main/runtime/tools/heapsnapshot#cli-usage) to analyze the collected snapshots. |
| |
| Upvote [the issue](https://github.com/dart-lang/leak_tracker/issues/125) to enable graphical snapshot analysis with DevTools. |
| |
| ## Auto-snapshotting limitations |
| |
| ### By platform |
| |
| Usage tracking does not work for web platform. |
| |
| ### By build mode |
| |
| While usage tracking events are available for all modes, auto-snapshotting |
| is on or off depending on the build mode: |
| |
| * **Enabled for:** Flutter debug and profile modes (equivalent to Dart debug and release modes). |
| * **Disabled for:** Flutter release mode (equivalent to Dart product mode). |
| |
| See [Dart build modes](https://github.com/dart-lang/site-www/issues/4436) |
| or [Flutter build modes](https://docs.flutter.dev/testing/build-modes). |
| |
| ## Contributing |
| |
| For general contributing information, see Dart-wide [CONTRIBUTING.md](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md). |
| |
| ### How to roll the latest version of `memory_usage` to the Dart SDK repo |
| |
| To upgrade Dart SDK with new version of `memory_usage` update leak_tracker commit |
| hash for leak_tracker_rev in [Dart SDK DEPS](https://github.com/dart-lang/sdk/blob/main/DEPS). |
