tp,ui,docs: Surface the display-video user-build sysprop in docs, record page and trace doctor (#6717)

Screen recording (`android.display.video`) is now capturable on `user`
(production) builds, not just `userdebug`. On user builds it must be
unlocked
  first, over ADB, until the next reboot:                              
 
adb shell setprop debug.tracing_video_allowed true
                                                                       
The property is cleared on reboot, so it has to be re-set after each
restart
before display video can be captured. Once set, capture works through
any of the
existing methods (the on-device toggle, the record page, or a raw
config).
                                                                       
This makes that requirement discoverable in three places:
**Docs** (`docs/data-sources/video-frames.md`)
- Drop the "userdebug devices only" statement.
- Add a "Prerequisite on `user` builds" section documenting the
property, the
command, and its reset-on-reboot behaviour; point the intro/TOC at it.
  **Record page** (`Display video frames` probe)                       
- The probe description now spells out the user-build requirement and
shows the
`setprop` command as a code snippet, and links to the data-source doc.
                                                                       
  **Trace doctor** (new `display_video_not_enabled` diagnostic)        
- Fires when a trace requested `android.display.video` but captured no
frames,
on a `user` build, with no producer error stats — the usual cause being
the
    property was not set. 
- The video-frames table is owned by the `video_frame_importer` plugin
and isn't
reachable from the common diagnostics framework, so the plugin now bumps
a new
`android_video_frames_emitted` stat per inserted frame; the rule reads
emptiness through that stat, alongside the existing `android_video_*`
error
    stats.
8 files changed
tree: aa68532594440726e9c05abc2e3e7fee8edf7382
  1. .github/
  2. ai/
  3. bazel/
  4. build_overrides/
  5. buildtools/
  6. contrib/
  7. docs/
  8. examples/
  9. gn/
  10. include/
  11. infra/
  12. protos/
  13. python/
  14. sdk/
  15. src/
  16. test/
  17. third_party/
  18. tools/
  19. ui/
  20. .bazelignore
  21. .bazelrc
  22. .bazelversion
  23. .clang-format
  24. .clang-tidy
  25. .git-blame-ignore-revs
  26. .gitallowed
  27. .gitattributes
  28. .gitignore
  29. .gn
  30. .style.yapf
  31. Android.bp
  32. Android.bp.extras
  33. BUILD
  34. BUILD.extras
  35. BUILD.gn
  36. CHANGELOG
  37. CONTRIBUTORS.txt
  38. DIR_METADATA
  39. heapprofd.rc
  40. LICENSE
  41. meson.build
  42. METADATA
  43. MODULE.bazel
  44. MODULE.bazel.lock
  45. MODULE_LICENSE_APACHE2
  46. OWNERS
  47. OWNERS.github
  48. perfetto.rc
  49. perfetto_flags.aconfig
  50. PerfettoIntegrationTests.xml
  51. persistent_cfg.pbtxt
  52. README.chromium
  53. README.md
  54. TEST_MAPPING
  55. traced_perf.rc
  56. WORKSPACE
README.md

Perfetto - System profiling, app tracing and trace analysis

Perfetto is an open-source suite of SDKs, daemons and tools which use tracing to help developers understand the behaviour of complex systems and root-cause functional and performance issues on client and embedded systems.

It is a production-grade tool that is the default tracing system for the Android operating system and the Chromium browser.

Core Components

Perfetto is not a single tool, but a collection of components that work together:

  • High-performance tracing daemons: For capturing tracing information from many processes on a single machine into a unified trace file.
  • Low-overhead tracing SDK: A C++17 library for direct userspace-to-userspace tracing of timings and state changes in your application.
  • Extensive OS-level probes: For capturing system-wide context on Android and Linux (e.g. scheduling states, CPU frequencies, memory profiling, callstack sampling).
  • Browser-based UI: A powerful, fully local UI for visualizing and exploring large, multi-GB traces on a timeline. It works in all major browsers, requires no installation, and can open traces from other tools.
  • SQL-based analysis library: A powerful engine that allows you to programmatically query traces using SQL to automate analysis and extract custom metrics.

Why Use Perfetto?

Perfetto was designed to be a versatile and powerful tracing system for a wide range of use cases.

  • For Android App & Platform Developers: Debug and root-cause functional and performance issues like slow startups, dropped frames (jank), animation glitches, low memory kills, and ANRs. Profile both Java/Kotlin and native C++ memory usage with heap dumps and profiles.
  • For C/C++ Developers (Linux, macOS, Windows): Use the Tracing SDK to instrument your application with custom trace points to understand its execution flow, find performance bottlenecks, and debug complex behavior. On Linux, you can also perform detailed CPU and native heap profiling.
  • For Linux Kernel & System Developers: Get deep insights into kernel behavior. Perfetto acts as an efficient userspace daemon for ftrace, allowing you to visualize scheduling, syscalls, interrupts, and custom kernel tracepoints on a timeline.
  • For Chromium Developers: Perfetto is the tracing backend for chrome://tracing. Use it to debug and root-cause issues in the browser, V8, and Blink.
  • For Performance Engineers & SREs: Analyze and visualize a wide range of profiling and tracing formats, not just Perfetto's. Use the powerful SQL interface to programmatically analyze traces from tools like Linux perf, macOS Instruments, Chrome JSON traces, and more.

Getting Started

We‘ve designed our documentation to guide you to the right information as quickly as possible, whether you’re a newcomer to performance analysis or an experienced developer.

  1. New to tracing? If you're unfamiliar with concepts like tracing and profiling, start here:

  2. Ready to dive in? Our “Getting Started” guide is the main entry point for all users. It will help you find the right tutorials and documentation for your specific needs:

  3. Want the full overview? For a comprehensive look at what Perfetto is, why it's useful, and who uses it, see our main documentation page:

Debian Distribution

For users interested in the Debian distribution of Perfetto, the official source of truth and packaging efforts are maintained at Debian Perfetto Salsa Repository

Community & Support

Have questions? Need help?

We follow Google's Open Source Community Guidelines.