Skip to main content

echolot-lockup-inverse-2x

CLI that helps your agent to find performance issues in Android apps.

checks codeql PyPI Python versions License Status


Contents · What it is · Requirements · Quick start · What you get · What changed · Commands · Detectors · How it works · Project layout · Documentation · Status


What it is

A Perfetto trace of one cold start holds around half a million slices in eighty megabytes. Nobody reads that, and an AI agent pointed at the raw file produces confident guesses instead of answers.

echolot sits in between. It runs ten SQL detectors over the trace and returns about twenty rows: where the time went, how much of it, and the evidence behind each claim. Same trace in, same report out — the trace_processor version is pinned and verified on every run.

[!TIP] The intended way to use it is through Claude Code: you describe the regression in plain words, the agent collects traces, reads the report and walks down to the code. The command line works on its own too — see without an agent.

Using Cursor, Codex or something else? echolot init points them at the tool, and echolot guide tells any agent how to work with it. The loop runs in your main context rather than a subagent, so keep the passes short — the guide says where that matters.

echolot reflect works from any of them: with no transcript to read it builds the report from the tool's own run log, and names every check it could not make rather than reporting silence as a clean bill.

Requirements

Python 3.10 or newer
adb on PATH — ships in the Android SDK platform-tools
Device a phone or emulator with USB debugging on
Agent (optional) Claude Code for the full workflow; Cursor, Codex and others via echolot guide
Android 12+ (for one detector) frame_jank reads SurfaceFlinger's frame timeline. Older devices do not have it, and the detector is then silent — which reads exactly like "no bad frames"

Validated on Android 14 (emulator) and Android 13 (Galaxy A51).

Quick start

1. Install

pipx install echolot

2. Set up your project

Run this once inside your Android project:

cd ~/my-app && echolot init

This installs the .claude/ layer — a skill, the perf-hunter agent and three commands — then checks that this machine computes traces correctly.

3. Open the agent and type one word

/echolot

That is the only entry point you need to remember. It asks the tool where the project stands and takes the next step by itself:

  • first run — builds echolot.yml from your repository and a probe trace, asking you four questions along the way;
  • every run after — hunts down the regression you describe.
/echolot                          reads the state, does whatever is next
/echolot why is cold start slow   hunt, with that as the question
/echolot init | setup | hunt | reflect | doctor

Coming back later

echolot

Prints where the project stands — layer, config, traces, last report, last doctor — and one line saying what to do next.

[!IMPORTANT] After upgrading the package, run echolot init again. It brings the .claude/ layer up to date and leaves files you edited alone.

Without an agent

The same work, by hand or in CI:

echolot collect -c echolot.yml -n 5                              # 5 repeats of the scenario
echolot analyze .echolot/traces/*.perfetto-trace -c echolot.yml  # build the report
echolot compare before.json .echolot/out/report.json             # what changed since
echolot doctor -q                                                # exit 0/1: is this environment sane?

Results land in .echolot/out/report.md for you, report.json for the agent.

What you get

A Marker Report: one section per detector that fired, nothing else.

Example report (click to expand)
# Marker Report

Runs: **5**, numbers are medians across them
Process: `com.example.app` (pid 12903)
Scenario window: **1184 ms** (from 1102 to 1291)
Detectors fired: **5 of 10**

## Where the main thread spent its time

_measured as SELF time, children subtracted_

| Where | N | Self, ms | Total, ms | Max, ms |
|---|---|---|---|---|
| draw | 4 | 125.4 | 130.1 | 61.2 |
| TextLayout:initLayout | 61 | 88.0 | 88.0 | 4.1 |
| inflate | 12 | 47.3 | 210.7 | 12.9 |

## Blind spots: threads burning CPU with no instrumentation

_the only detector that finds a problem inside uninstrumented code_

| Where | Total, ms | Instrumented, ms | Evidence |
|---|---|---|---|
| DefaultDispatcher-worker-2 | 340.2 | 0.0 | 0 slices |

## Monitor contention

| Where | N | Total, ms | Max, ms | Evidence |
|---|---|---|---|---|
| Lock contention on a monitor lock | 9 | 61.5 | 22.4 | owner tid 12931 |

## Frames that missed their deadline

_time past the deadline; frame duration is in the evidence_

| Where | N | Total, ms | Max, ms | Evidence |
|---|---|---|---|---|
| App Deadline Missed | 14 | 412.0 | 70.1 | Self Jank · 14 of 300 frames · longest 86.2 ms |

## Single occurrences far longer than the same work usually takes

| Where | N | Total, ms | Max, ms | Evidence |
|---|---|---|---|---|
| inflate | 2 | 149.3 | 86.2 | median 12.9 ms of 312 · worst 6.7× |

**Silent:** gc_pressure, binder_txn, runnable_starvation, anr_risk, anr

The report is written for two readers at once: report.md reads like a findings list, report.json carries the same numbers in a shape the agent can walk. An 81 MB trace with 475k slices comes out as a 14 KB report.json in about five seconds.

What changed

The report says where the time went in one set of traces. The question people arrive with has a second half — it was 3 s, now it is 7 s — and that needs two sets.

echolot compare                       # inside an investigation: previous round vs latest
echolot compare old.json new.json     # or name them

One table, sorted by how far each row moved. The top row is usually the answer.

Where Evidence Detector Before After Δ N Ranges
SyncAdapter.onPerformSync uninstrumented_cpu 1402.0 ±61 new — → 0
TeamRepository.loadAll main main_thread_block 12.1 ±2 883.4 ±40 +871.3 ×73.01 1 → 1 apart
inflate main main_thread_block 47.3 ±31 121.9 ±88 +74.6 ×2.58 12 → 31 overlap

N separates "called more often" from "became slower inside" — two different bugs in two different places. Ranges is the column that decides whether a row is worth acting on: apart means every repeat after fell outside everything seen before, overlap means the runs disagree among themselves by more than the medians moved, and the honest next step is another round of collect rather than a conclusion.

Reports built against different thresholds are compared with the reason printed above the table — a row can cross a moved bar without anything in the app changing. See Comparing.

Commands

Three audiences share one CLI, and echolot --help says which is which — the grouping below is generated from the same registration, so the two cannot drift apart.

Every argument after /echolot is a verb of the same name, doing the same thing plus whatever loop needs an agent. One word, one meaning, both surfaces.

Yours

command what it does
echolot where this project stands, and the next step
echolot init install or update the .claude/ layer; checks the environment
echolot hunt "<what regressed>" open an investigation — see below
echolot doctor environment + self-check on a synthetic trace; exit 0/1, -q for three lines

The pipeline — for CI, and for traces by hand

command what it does
echolot collect capture N traces of one scenario — launch, command or gradle
echolot analyze run the detectors, build a Marker Report
echolot compare the difference between two reports — see below
The agent's, behind /echolot — you do not call these
command what it does
guide how to work with this tool, printed by the package — what an agent without the .claude/ layer reads instead of it
anr an ANR report from the field — the lock chain, the few threads that were not idle, and where their frames are in this checkout. Crashlytics exports and the device's own dumpsys dropbox record
probe processes, threads by CPU, scenario anchor candidates
names slice name inventory and detector mask coverage
domains slice-to-code map and instrumentation coverage
mark the first temporary markers for a project with none, from the manifest and the SDK, or from an ANR report's own frames with --from-anr--apply / --remove
calibrate thresholds derived from known-healthy runs
explain list the detectors and their parameters
For improving the tool
command what it does
reflect the same kind of report, over an agent session — how the tool was used, where it got in the way. Full detail for Claude Code; from anywhere else, built from the run log and honest about what it could not see

The investigation

.echolot/traces/ and .echolot/out/report.json mean "the latest set". An investigation is the label that says which question that set was recorded for, so that coming back a week later does not answer a question about scrolling with cold-start traces.

echolot hunt "cold start was 3s, now 7s" --since "the tab redesign"

That opens one, moves the previous set of traces aside without deleting it, and says whether the last investigation left temporary markers in your sources. echolot hunt on its own says what is open.

echolot hunt --list          every investigation, newest first
echolot hunt --show 2        one of them in full — including where its traces went
echolot hunt --resume        carry on with the open one
echolot hunt --done "..."    record what it came to

Each one is numbered, and everything it produces is filed under it: every round of traces by path, every report as a copy in .echolot/hunts/<n>/reports/. So a question asked three weeks ago still knows what was measured to answer it, and what each round concluded on the way.

Nothing moves to make this work — collect still writes to .echolot/traces/ and the latest report is still .echolot/out/report.json, so every example above and any CI job keep working unchanged.

You rarely type any of it. /echolot reads the state and, when an investigation has been sitting untouched with traces behind it, asks whether to carry on or start something new — and never asks inside the hunting loop, which re-records and re-instruments on purpose.

Detectors

detector what it catches
main_thread_block where the main thread spent its time, by self time
gc_pressure frequent or expensive GC, and waits on allocation
monitor_contention lock contention, with the owner's tid as evidence
binder_txn long synchronous IPC, and death by a thousand cuts
runnable_starvation thread ready to run but preempted on CPU
uninstrumented_cpu threads burning CPU with no instrumentation
frame_jank frames that missed their deadline, and whose fault it was
anr_risk stretches where the main thread never got back to the message queue
anr ANRs the system recorded during the trace, with its own reason
main_thread_outlier one occurrence far longer than that work usually takes

Two of them find something where nobody wrote a trace{} call.

uninstrumented_cpu does not guess — it states a fact:

thread DefaultDispatcher-worker-2 was Running for 340 ms, zero slices

Which is exactly where to add trace{} and record again.

frame_jank needs no instrumentation at all: SurfaceFlinger records every frame's deadline and what it actually took, and says whose fault a miss was. Android 12 and up — see requirements.

main_thread_block and main_thread_outlier are a pair, and reading one as the other wastes a round. The first gates on the sum for a name and answers "where did the time go". The second gates on a single occurrence against the median for that same name and answers "which one was out of line". A name can appear in both, saying different things — and they lead to different places: expensive every time means the fix is in that work, usually fine and once not means the cause is the state it hit that once.

[!NOTE] Each detector is one self-contained .sql file with its metadata in the header. Drop a file into echolot/sql/detectors/ and it is picked up — there is no registration step in code. See docs/detectors.md.

How it works

flowchart LR
    A["Android device"]
    B["trace<br/>81 MB · 475k slices"]
    C["10 SQL detectors<br/>pinned trace_processor"]
    D["report.md<br/>~20 rows"]
    E["report.json<br/>14 KB"]
    H["comparison<br/>what moved, and by how much"]
    F(["You"])
    G(["The agent"])

    A -->|"echolot collect"| B
    B -->|"echolot analyze"| C
    C --> D --> F
    C --> E --> G
    E -->|"echolot compare, against an earlier one"| H
    H --> F
    H --> G

Project layout

android-project/
├── echolot.yml       ← the project half, committed
├── local.yml         ← device serials, binary path; in .gitignore
└── .echolot/         ← traces, reports, run log, reflect reports; in .gitignore

Read it the way you read gradle.properties and local.properties: one tool per machine, and the binding to a project living inside that project's repository.

Documentation

Start at the documentation index, or jump straight in:

document about
🎬 Collecting collect, the three modes, merging repeats
🔎 Analysing probe, names, domains — from a trace to a place in the code
🔀 Comparing compare — what changed between two reports, and when the repeats support saying so
🧊 ANRs anr — reading a report from the field, and measuring a freeze
🏷️ Marking mark — first markers for a project with no instrumentation
⚙️ Detectors writing your own, the context views, self time versus total
📏 Calibrating thresholds from healthy runs, why rank beats percentile
🔒 Determinism the pinned trace_processor, doctor, the self-check
🤖 The agent layer the .claude/ layer, and why the loop lives in a subagent
🪞 Reflect the report over an agent session, for improving the tool

Agent-facing reference material ships inside the package under echolot/claude/skills/echolot/references/ — the report schema, the config schema, how ART names things, and how to capture a trace by hand.

Status

v0. Everything planned for it is in place.

The detectors were validated against a synthetic trace — 97 checks inside doctor, one per claim — and against live traces from Android 14 (emulator) and Android 13 (Galaxy A51). The naming masks for GC, locks and binder were narrowed against those real traces, and every narrowing is pinned by a check.

Two are newer than that hardware round and have not had one. frame_jank was built against the pinned trace_processor and a frame timeline written for the purpose — the column names, the jank vocabulary and where display frames live were all read back out of it rather than assumed — but no report from it has been compared with a real device's own frame statistics yet. main_thread_outlier was written for a miss recorded on an A51 and has so far answered only the fixture.

A failed detector never fails the run: the error goes to stderr and into report.json.

Working on the tool

pip install -e '.[dev]'
pytest                       # every check, including the ones doctor runs
pytest -k uninstrumented     # one detector's claims, by name

doctor stays dependency-free: it walks the same list itself, because it runs on a user's laptop where pytest is not installed.

There is no CI gate, on purpose

An earlier plan had analyze exit non-zero against scenario.budget_ms, so a build could fail on a slow run. It is not being built, and this is the reason.

"Did it get slower" is already answered. Macrobenchmark writes percentiles per iteration right next to the traces echolot collects from it, and comparing a median against a number is a few lines of anything. An eleventh implementation of that adds nothing. Worse, detector thresholds on a shared CI runner would fire on properties of the runner — the same caution this tool already gives about runnable_starvation on a loaded machine.

Where echolot is hard to replace is the other question: where the time went. So the useful shape in CI is the opposite of a gate. Run echolot doctor -q as a precondition — it already answers "does this machine compute correctly" with an exit code — then analyze over the traces the benchmark has already written, compare against yesterday's report, and keep both JSON files as build artefacts. When someone asks a day later why the nightly regressed, the window, the thresholds, the evidence and the delta are already sitting next to the commit: no device, no re-recording.

compare exits 0 whatever it finds, for the same reason. It reports; it does not stand guard.

scenario.budget_ms stays in the config. It records what a team considers acceptable, which is worth writing down whether or not anything enforces it.

License

Apache 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

echolot-0.5.1.tar.gz (306.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

echolot-0.5.1-py3-none-any.whl (279.7 kB view details)

Uploaded Python 3

File details

Details for the file echolot-0.5.1.tar.gz.

File metadata

  • Download URL: echolot-0.5.1.tar.gz
  • Upload date:
  • Size: 306.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for echolot-0.5.1.tar.gz
Algorithm Hash digest
SHA256 f3eae57919a0f3474aecde24d16573de6ab50c4ca0bc197643a7283ef9c5d73b
MD5 90c5531b6c9e2fcd91b61b74df0d0da0
BLAKE2b-256 eef479a1d3a3d95b3da40770c6ca5beff37da6c180d863842942824e59d73ac4

See more details on using hashes here.

Provenance

The following attestation bundles were made for echolot-0.5.1.tar.gz:

Publisher: publish.yml on grishan0v/echolot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file echolot-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: echolot-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 279.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for echolot-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d42f0c14b5f146c6e0f90f1bebb2f236efd97acb23bdc95fc22988e8ea33bbe
MD5 521b5244c79f101567ed90669ea99fa3
BLAKE2b-256 5c13f314bebd6eaa8dae4a5bb2d9ccedca24b004391f50a675fbc8600188035d

See more details on using hashes here.

Provenance

The following attestation bundles were made for echolot-0.5.1-py3-none-any.whl:

Publisher: publish.yml on grishan0v/echolot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.5.3

2 files

0.5.2

2 files

This release

0.5.1 This release

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page