Hanzo
OpenapiO11y

Lists the instrumented services seen in the window, each with the request…

Lists the instrumented services seen in the window, each with the request profile of its entry-point spans: p99 and average latency, call and error rates,…

POST /v1/o11y/services

Addresshttps://api.hanzo.ai/v1/o11y/services
MethodPOST
Operationpost_o11y_services
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the instrumented services seen in the window, each with the request profile of its entry-point spans: p99 and average latency, call and error rates, and the entry-point operations the numbers were computed over.

Request

9 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodystringEnd is the window's end, epoch nanoseconds as a string.
startbodystringStart is the window's start, epoch nanoseconds as a string.
tagsbodyo11y.O11yServiceTag[]Tags narrow the spans counted, each a span-attribute predicate.
tags[].BoolValuesbodyboolean[]BoolValues are the boolean operands, when the attribute is a bool.
tags[].KeybodystringKey is the span attribute to test.
tags[].NumberValuesbodynumber[]NumberValues are the numeric operands, when the attribute is a number.
tags[].OperatorbodystringOperator is how to test it, e.g.
tags[].StringValuesbodystring[]StringValues are the string operands, when the attribute is a string.
tags[].TagTypebodystringTagType says which plane the attribute lives on, e.g.

Response

StatusBodyMeaning
200o11y.O11yServicesOutok

200 body — 13 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yService[]Data holds one entry per service.
data[].avgDurationbodynumberAvgDuration is their average latency, nanoseconds.
data[].callRatebodynumberCallRate is calls per second over the window.
data[].dataWarningbodyo11y.O11yServiceWarning
data[].dataWarning.topLevelOpsbodystring[]TopLevelOps are the entry-point operations the profile was computed over.
data[].errorRatebodynumberErrorRate is the percentage of calls that errored.
data[].fourXXRatebodynumberFourXXRate is the percentage of calls that answered 4xx.
data[].num4XXbodyintegerNum4XX is how many of the calls answered 4xx.
data[].numCallsbodyintegerNumCalls is how many entry-point spans landed in the window.
data[].numErrorsbodyintegerNumErrors is how many of the calls errored.
data[].p99bodynumberPercentile99 is the p99 latency of its entry-point spans, nanoseconds.
data[].serviceNamebodystringServiceName is the service.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y services create

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page