This document was last reviewed for accuracy on: 2019-08-20
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.
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.
TODO(4548): Inspect will be available in the SDK.
#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.
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