Reports whether the metrics and attributes an infra-monitoring section needs…
Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what…
GET /v1/o11y/infra_monitoring/checks
| Address | https://api.hanzo.ai/v1/o11y/infra_monitoring/checks |
| Method | GET |
| Operation | get_o11y_infra_monitoring_checks |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what is present and what is missing, with a user-facing message and a docs link per missing piece. Ready is true only when nothing is missing.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
type | query | string | yes | Type is the section to check — hosts, processes, pods, nodes, deployments, daemonsets, statefulsets, jobs, namespaces, clusters or volumes. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yInfraChecksOut | ok |
200 body — 40 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.Checks | — | |
data.missingDefaultEnabledMetrics | body | o11y.MissingMetricsComponentEntry[] | — | |
data.missingDefaultEnabledMetrics[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.missingDefaultEnabledMetrics[].associatedComponent.name | body | string | — | |
data.missingDefaultEnabledMetrics[].associatedComponent.type | body | any | — | |
data.missingDefaultEnabledMetrics[].documentationLink | body | string | — | |
data.missingDefaultEnabledMetrics[].message | body | string | — | |
data.missingDefaultEnabledMetrics[].metrics | body | string[] | — | |
data.missingOptionalMetrics | body | o11y.MissingMetricsComponentEntry[] | — | |
data.missingOptionalMetrics[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.missingOptionalMetrics[].associatedComponent.name | body | string | — | |
data.missingOptionalMetrics[].associatedComponent.type | body | any | — | |
data.missingOptionalMetrics[].documentationLink | body | string | — | |
data.missingOptionalMetrics[].message | body | string | — | |
data.missingOptionalMetrics[].metrics | body | string[] | — | |
data.missingRequiredAttributes | body | o11y.MissingAttributesComponentEntry[] | — | |
data.missingRequiredAttributes[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.missingRequiredAttributes[].associatedComponent.name | body | string | — | |
data.missingRequiredAttributes[].associatedComponent.type | body | any | — | |
data.missingRequiredAttributes[].attributes | body | string[] | — | |
data.missingRequiredAttributes[].documentationLink | body | string | — | |
data.missingRequiredAttributes[].message | body | string | — | |
data.presentDefaultEnabledMetrics | body | o11y.MetricsComponentEntry[] | — | |
data.presentDefaultEnabledMetrics[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.presentDefaultEnabledMetrics[].associatedComponent.name | body | string | — | |
data.presentDefaultEnabledMetrics[].associatedComponent.type | body | any | — | |
data.presentDefaultEnabledMetrics[].metrics | body | string[] | — | |
data.presentOptionalMetrics | body | o11y.MetricsComponentEntry[] | — | |
data.presentOptionalMetrics[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.presentOptionalMetrics[].associatedComponent.name | body | string | — | |
data.presentOptionalMetrics[].associatedComponent.type | body | any | — | |
data.presentOptionalMetrics[].metrics | body | string[] | — | |
data.presentRequiredAttributes | body | o11y.AttributesComponentEntry[] | — | |
data.presentRequiredAttributes[].associatedComponent | body | o11y.AssociatedComponent | — | |
data.presentRequiredAttributes[].associatedComponent.name | body | string | — | |
data.presentRequiredAttributes[].associatedComponent.type | body | any | — | |
data.presentRequiredAttributes[].attributes | body | string[] | — | |
data.ready | body | boolean | — | |
data.type | body | any | — | |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y infra_monitoring checks --type <type>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11yInfraMonitoringChecks({ type: 'type' });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).get_o11y_infra_monitoring_checks(type='type')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetO11yInfraMonitoringChecks(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::get_o11y_infra_monitoring_checks(&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).getO11yInfraMonitoringChecks();curl https://api.hanzo.ai/v1/o11y/infra_monitoring/checks?type=%3Ctype%3E \
-H "Authorization: Bearer $HANZO_API_KEY"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?