Hanzo
OpenapiO11y

Checks whether the spans the Kafka consumer views need are arriving, row for…

Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.

POST /v1/o11y/messaging-queues/kafka/onboarding/consumers

Addresshttps://api.hanzo.ai/v1/o11y/messaging-queues/kafka/onboarding/consumers
MethodPOST
Operationpost_o11y_messaging-queues_kafka_onboarding_consumers
AuthAuthorization: Bearer $HANZO_API_KEY

Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodyintegerEnd is the window's end, epoch nanoseconds.
eval_timebodyintegerEvalTime bounds the span-evaluation scan, nanoseconds; only the span/evaluation view reads it.
startbodyintegerStart is the window's start, epoch nanoseconds.
variablesbodyobjectVariables name what the view drills into — topic, partition, service, consumer_group — keyed by the name the view expects.
variables.*bodystring

Response

StatusBodyMeaning
200o11y.O11yQueueChecksOutok

200 body — 5 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yQueueCheck[]Data holds one check per required attribute, sorted by attribute.
data[].attributebodystringAttribute is the span attribute or telemetry the check looked for.
data[].error_messagebodystringMessage says what is missing when the check fails; empty on a pass.
data[].statusbodystringStatus is "1" when the telemetry is present, "0" when it is not.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y messaging-queues kafka onboarding consumers

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page