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

hierarchy

This macro simplifies creating diagnostics hierarchies, to remove the need of writing multiple nested hierarchies and manually writing all properties.

Structs

BuilderArgs

Arguments used to create a new LogsDataBuilder.

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.

InspectDataBuilder

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.

Enums

DataSource

The source of diagnostics data

Error

Errors that can happen in this library.

ExtendedMoniker

One of:

InspectHandleName

The possible name for a handle to inspect data. It could be a filename (being deprecated) or a name published using fuchsia.inspect.InspectSink.

LogError

Possible errors that can come in a DiagnosticsData object where the data source is DataSource::Logs.

LogTextColor

Configuration for the color of a log line that is displayed in tools using LogTextPresenter.

LogTimeDisplayFormat

Configuration for how to display the timestamp associated to a log line.

LogsField

An enum containing well known argument names passed through logs, as well as an Other variant for any other argument names.

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”.

Timezone

Options for the timezone associated to the timestamp of a log line.

Constants

DROPPED_LABEL

The label for the number of dropped logs in the log metadata.

FILE_PATH_LABEL

The label for the file associated with a log line.

LINE_NUMBER_LABEL

The label for the line number in the file associated with a log line.

MESSAGE_LABEL

The label for the message in the log payload.

MESSAGE_LABEL_STRUCTURED

The label for the contents of a message in the log payload.

PID_LABEL

The label for the process koid in the log metadata.

TAG_LABEL

The label for a tag in the log metadata.

TID_LABEL

The label for the thread koid in the log metadata.

Traits

DiagnosticsData

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

Metadata

MetadataError

Functions

deserialize_timestamp

serialize_timestamp

Type Aliases

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.

Timestamp