Hanzo
OpenapiO11y

Updates one metric's metadata — description, type, unit, temporality,…

Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.

POST /v1/o11y/metrics/metadata

Addresshttps://api.hanzo.ai/v1/o11y/metrics/metadata
MethodPOST
OperationUpdateMetricMetadata
AuthAuthorization: Bearer $HANZO_API_KEY

Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
descriptionbodystringDescription describes the metric.
isMonotonicbodybooleanIsMonotonic marks a sum that only ever increases.
metricNamebodystringyesMetricName is the metric to update.
temporalitybodystringTemporality is delta or cumulative.
typebodystringType is the metric type, e.g.
unitbodystringUnit is the metric's unit.

Response

StatusBodyMeaning
200o11y.O11yMetricAckOutok

200 body — 1 field.

FieldInTypeAlwaysDescription
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metrics metadata create --metric-name <metricName>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page