tree: d7b42405705ccc95cebf0a398006f768be682c29 [path history] [tgz]
  1. BUILD.gn
  2. README.md
  3. health.cc
  4. hierarchy.cc
  5. include/
  6. inspector.cc
  7. reader.cc
  8. test/
  9. vmo/
zircon/system/ulib/inspect/README.md

Inspect Library

This document was last reviewed for accuracy on: 2019-10-31

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

Unit tests for inspect are available in the Zircon tests package.

To include them, you must pass --with-base //garnet/packages/tests:zircon to fx set and re-pave your device.

$ fx shell runtests -t inspect-test