Repository navigation
Docs idea: telling "no jank found" apart from "no frames were collected" when profiling #1025
Ky0-Nguyen
started this conversation in
Ideas
Replies: 1 comment 1 reply
|
This is a useful documentation improvement because “no jank found” and “no frames were collected” represent two different profiling outcomes. I suggest making the distinction explicit in the profiling results:
It would also help to show a clear message when no frames are available, explaining possible reasons such as an inactive recording session, an unsupported profiling environment, or a recording that ended before any frames were captured. This distinction prevents users from interpreting missing profiling data as proof that their application is performing smoothly. A small UI example could be: versus: The documentation should also clarify what counts as a valid frame and which threshold is used to classify jank. |
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Summary
A small docs proposal, and optionally a short community blog post, about an easy-to-miss profiling mistake: a capture that contains no frame or CPU data still produces a clean-looking result. "No jank found" and "no frames were collected" read the same in a summary, but only the first one says anything about the app.
Motivation
I ran into this while profiling a small React Native CLI app:
In both cases nothing looked broken. The data simply was not there, and it is easy to read an empty track as a fast app. I suspect many people hit this without noticing, especially when a tool shows a green summary.
Proposal
Choreographer#doFrameon the UI thread andDrawFrameon the RenderThread in Android Studio or Perfetto) and CPU samples for your app's process during the interaction you care about. An empty track means not measured, not fast.Transparency
I maintain an open-source macOS profiler for React Native (DevX), which is where this came up. Neither the docs change nor the post would be about it; they would only reference the tools already used in the docs.
Questions
Happy to open the PR(s) if this sounds useful.
All reactions