Hanzo
OpenapiO11y

Returns one metric's metadata: description, type, unit, temporality and…

Returns one metric's metadata: description, type, unit, temporality and monotonicity.

GET /v1/o11y/metrics/metadata

Addresshttps://api.hanzo.ai/v1/o11y/metrics/metadata
MethodGET
OperationGetMetricMetadata
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one metric's metadata: description, type, unit, temporality and monotonicity.

Request

1 field.

FieldInTypeRequiredDescription
metricNamequerystringyesMetricName is the metric's name; it may contain slashes, e.g.

Response

StatusBodyMeaning
200o11y.O11yMetricMetadataOutok

200 body — 7 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yMetricMetadata
data.descriptionbodystringDescription describes the metric.
data.isMonotonicbodybooleanIsMonotonic marks a sum that only ever increases.
data.temporalitybodystringTemporality is delta or cumulative.
data.typebodystringType is the metric type, e.g.
data.unitbodystringUnit is the metric's unit.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics metadata get --metric-name <metric-name>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page