tree: db1f67963d8d49ab3f2364e86a7123f64312003d [path history] [tgz]
  1. include/
  2. tests/
  3. vmo/
  4. BUILD.gn
  5. health.cc
  6. hierarchy.cc
  7. inspector.cc
  8. METADATA.textproto
  9. OWNERS
  10. reader.cc
  11. README.md
zircon/system/ulib/inspect/README.md

Inspect Library

This document was last reviewed for accuracy on: 2022-06-10

Inspect is a library for exposing structured, hierarchical diagnostics information from components at runtime. Full documentation for the Component Inspection project can be found here.

Using

Inspect can be used in-tree by depending on the //zircon/public/lib/inspect GN target and using #include <lib/inspect/cpp/inspect.h>.

Our quickstart guide is available here.

Inspect data may be read from components using the iquery tool.

Inspect is also available in the SDK.

Includes

#include <lib/inspect/cpp/inspect.h>

Support for writing Inspect data to a VMO.

#include <lib/inspect/cpp/reader.h>

Support for reading Inspect data from a VMO or an inspect::Snapshot of a VMO.

#include <lib/inspect/cpp/health.h>

Support for attaching health information to Inspect nodes. This information can be read and aggregated by iquery --health.

Testing

fx set ... --with //zircon/system/ulib/inspect:tests
fx test -od inspect-cpp-unittest