Crate diagnostics_data

Diagnostics data

This library contains the Diagnostics data schema used for inspect and logs . This is the data that the Archive returns on fuchsia.diagnostics.ArchiveAccessor reads.

Macros

• assert_data_tree
  Macro to simplify tree matching in tests. The first argument is the actual tree passed as a DiagnosticsHierarchyGetter (e.g. a DiagnosticsHierarchy or an Inspector). The second argument is given to tree_assertion! which creates a TreeAssertion to validate the tree.
• hierarchy
  This macro simplifies creating diagnostics hierarchies, to remove the need of writing multiple nested hierarchies and manually writing all properties.
• tree_assertion
  Macro to simplify creating TreeAssertions. Commonly used indirectly through the second parameter of assert_data_tree!. See assert_data_tree! for more usage examples.

Structs

• BuilderArgs
• Data
  An instance of diagnostics data with typed metadata and an optional nested payload.
• DiagnosticsHierarchy
  A hierarchy of nodes representing structured data, such as Inspect or structured log data.
• Inspect
  Inspect carries snapshots of data trees hosted by components.
• InspectError
  Possible error that can come in a DiagnosticsData object where the data source is DataSource::Inspect..
• InspectMetadata
  The metadata contained in a DiagnosticsData object where the data source is DataSource::Inspect.
• LogTextDisplayOptions
  Display options for unstructured logs.
• LogTextPresenter
  Used to control stringification options of Data
• Logs
  Logs carry streams of structured events from components.
• LogsDataBuilder
  Internal state of the LogsDataBuilder impl External customers should not directly access these fields.
• LogsMetadata
  The metadata contained in a DiagnosticsData object where the data source is DataSource::Logs.
• Timestamp
  Wraps a time for serialization and deserialization purposes.

Enums

• DataSource
  The source of diagnostics data
• InspectHandleName
• LegacySeverity
• LogError
  Possible errors that can come in a DiagnosticsData object where the data source is DataSource::Logs.
• LogsField
  An enum containing well known argument names passed through logs, as well as an Other variant for any other argument names.
• Metadata
  Metadata contained in a DiagnosticsData object.
• Property
  A named property. Each of the fields consists of (name, value).
• Severity
  Severities a log message can have, often called the log’s “level”.
• SeverityError

Constants

• ARGS_LABEL
• DROPPED_LABEL
• FILE_PATH_LABEL
• FORMAT_LABEL
• LINE_NUMBER_LABEL
• MESSAGE_LABEL
• MESSAGE_LABEL_STRUCTURED
• PID_LABEL
• TAG_LABEL
• TID_LABEL
• VERBOSITY_LABEL

Traits

• DiagnosticsData
  A trait implemented by marker types which denote “kinds” of diagnostics data.

Type Definitions

• InspectData
  A diagnostics data object containing inspect data.
• LogsData
  A diagnostics data object containing logs data.
• LogsHierarchy
  A diagnostics data payload containing logs data.
• LogsProperty
  A diagnostics hierarchy property keyed by LogsField.