Skip to main content

Interface: Metric

common.Metric

Base interface for all metrics.

The Metric API is an experimental feature and may be subject to change.

Hierarchy​

Properties​

description​

• Optional description: string

The description of the metric, if any.

kind​

• kind: MetricKind

The kind of the metric (e.g. counter, histogram, gauge).

name​

• name: string

The name of the metric.

unit​

• Optional unit: string

The unit of the metric, if any.

valueType​

• valueType: NumericMetricValueType

The type of value recorded by the metric. Either int or float.