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
| Address | https://api.hanzo.ai/v1/o11y/messaging-queues/kafka/onboarding/consumers |
| Method | POST |
| Operation | post_o11y_messaging-queues_kafka_onboarding_consumers |
| Auth | Authorization: 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).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
end | body | integer | — | End is the window's end, epoch nanoseconds. |
eval_time | body | integer | — | EvalTime bounds the span-evaluation scan, nanoseconds; only the span/evaluation view reads it. |
start | body | integer | — | Start is the window's start, epoch nanoseconds. |
variables | body | object | — | Variables name what the view drills into — topic, partition, service, consumer_group — keyed by the name the view expects. |
variables.* | body | string | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yQueueChecksOut | ok |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yQueueCheck[] | — | Data holds one check per required attribute, sorted by attribute. |
data[].attribute | body | string | — | Attribute is the span attribute or telemetry the check looked for. |
data[].error_message | body | string | — | Message says what is missing when the check fails; empty on a pass. |
data[].status | body | string | — | Status is "1" when the telemetry is present, "0" when it is not. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y messaging-queues kafka onboarding consumersimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yMessaging-queuesKafkaOnboardingConsumers({ end: 0, eval_time: 0 });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).post_o11y_messaging-queues_kafka_onboarding_consumers(end=0, eval_time=0)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PostO11yMessaging-queuesKafkaOnboardingConsumers(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, o11y_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = o11y_api::post_o11y_messaging-queues_kafka_onboarding_consumers(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).postO11yMessaging-queuesKafkaOnboardingConsumers();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/o11y/messaging-queues/kafka/onboarding/consumers \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"end": 0,
"eval_time": 0
}'The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_o11y_alert_last"
}
}
}'How is this guide?