android signals heaps

Lists, describes, and downloads heap dumps collected on low-memory events.

Usage

android signals heaps [-h] [--firebase-app=PARAM]

Options

  • --firebase-app=PARAM - Firebase app ID to query in Crashlytics (e.g. '1::android:').
  • -h,--help - Shows the help message for the specified command.

android options:

  • --sdk=PARAM - Path to the Android SDK.
  • -v,--verbose - Enable verbose output for troubleshooting.
  • -V,--version - Print version information and exit.

Subcommands

  • describe - Describes a heap dump with the issue, metadata, custom keys, and logs of its Crashlytics event, without the stack trace.
  • download - Downloads heap dumps as Perfetto traces into a local directory.
  • list - Lists heap dumps with their collection time, app version, device, API level, and size.

Description

The android signals heaps command set lists, inspects, and downloads heap dumps collected on low-memory events (such as out-of-memory crashes and memory limiter kills) and stored in Cloud Storage.

Typical workflow

Here is the sequence of commands for a typical workflow:

  1. Identify low-memory issues in android signals crashes list (tagged [OOM] or [MLK]), or run android signals heaps list to view all available heap dumps for your app.
  2. Run android signals heaps describe <heap-id> to inspect a heap dump alongside the metadata, custom keys, and logs from its crash session.
  3. Run android signals heaps download <heap-id...> to download heap dumps as Perfetto traces into a local directory for analysis.

Select an app (--firebase-app)

Pass --firebase-app=<app-id> (for example, 1:<project_number>:android:<hash>) to identify the app, or configure it in ~/.androidrc.

Examples

List low-memory heap dumps:

android signals heaps list --firebase-app=1:123456789012:android:0123456789abcdef

Describe a heap dump:

android signals heaps describe firebase/<heap-id> --firebase-app=1:123456789012:android:0123456789abcdef

Download a heap dump into the ./heaps directory:

android signals heaps download firebase/<heap-id> --output=./heaps --firebase-app=1:123456789012:android:0123456789abcdef