Hanzo
OpenapiO11y

Serves the OLDER /metric/metric_metadata route.

Serves the OLDER /metric/metric_metadata route.

GET /v1/o11y/metric/metric_metadata

Addresshttps://api.hanzo.ai/v1/o11y/metric/metric_metadata
MethodGET
Operationget_o11y_metric_metric_metadata
AuthAuthorization: Bearer $HANZO_API_KEY

Serves the OLDER /metric/metric_metadata route. It is NOT the same op as metrics.go's metricMetadata (/metrics/metadata): different path, different input (this one also scopes by service). Two slices named one Go function for two routes; the route is the identity, so the name follows it. Renamed rather than merged — collapsing them would silently drop the service scope this one accepts. It returns one metric's metadata — its type, unit, description, temporality, monotonicity and histogram buckets — optionally scoped to the metric as one service reports it.

Callers need the viewer role; the runtime's own gate enforces it.

Request

2 fields.

FieldInTypeRequiredDescription
metricNamequerystringMetricName is the metric to read.
serviceNamequerystringServiceName scopes the metadata to the metric as one service reports it.

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 metric metric_metadata

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page