contracts package

Defines classes for collecting structured metrics and events telemetry.

Structured telemetry is collected based on a common schema instead of free text logging of the data. Using a schema enables easier post-analysis of the data. Metrics and events in a common schema are collected with RequiredFields, StandardFields, and ExtensionFields.

Classes

TelemetryObjectBase

Defines the base class for collecting schematized telemetry events and metrics.

Use Metric for collecting and aggregating data, and Event for collecting low volume events with a defined schema use events. Both types of telemetry use a schema instead of free text for logging the data. The schema defines required, standard, and extension fields.

Event

Event object for telemetry usage.

Use events for collecting events with a defined schema.

Metric

Metric object for telemetry usage.

Use metrics for collecting and aggregating data that can be best aggregated into buckets for analysis.

RequiredFields

Defines Part A of the logging schema, keys that have a common meaning across telemetry data.

StandardFields

Defines Part B of the logging schema, optional keys that have a common meaning across telemetry data.

ExtensionFields

Defines Part C of the logging schema, keys that can be customized for telemetry data.