OpenapiO11y
Reports how far Kubernetes infra onboarding has progressed: which metric…
Reports how far Kubernetes infra onboarding has progressed: which metric families have arrived and, per pod, which required metadata labels are present.
GET /v1/o11y/infra_onboarding/k8s/status
| Address | https://api.hanzo.ai/v1/o11y/infra_onboarding/k8s/status |
| Method | GET |
| Operation | get_o11y_infra_onboarding_k8s_status |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports how far Kubernetes infra onboarding has progressed: which metric families have arrived and, per pod, which required metadata labels are present.
Callers need the viewer role; the runtime's own gate enforces it.
Request
GET /v1/o11y/infra_onboarding/k8s/status takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yOnboardingOut | ok |
200 body — 19 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yK8sOnboarding | — | |
data.didSendClusterMetrics | body | boolean | — | DidSendClusterMetrics says whether cluster metrics have arrived. |
data.didSendNodeMetrics | body | boolean | — | DidSendNodeMetrics says whether node metrics have arrived. |
data.didSendPodMetrics | body | boolean | — | DidSendPodMetrics says whether pod metrics have arrived. |
data.isSendingOptionalPodMetrics | body | boolean | — | IsSendingOptionalPodMetrics says whether optional pod metrics are flowing. |
data.isSendingRequiredMetadata | body | o11y.O11yPodOnboarding[] | — | IsSendingRequiredMetadata reports, per pod, which required metadata labels are present. |
data.isSendingRequiredMetadata[].clusterName | body | string | — | ClusterName is the pod's cluster. |
data.isSendingRequiredMetadata[].hasClusterName | body | boolean | — | HasClusterName says whether the cluster label is present. |
data.isSendingRequiredMetadata[].hasCronjobName | body | boolean | — | HasCronjobName says whether the cronjob label is present. |
data.isSendingRequiredMetadata[].hasDaemonsetName | body | boolean | — | HasDaemonsetName says whether the daemonset label is present. |
data.isSendingRequiredMetadata[].hasDeploymentName | body | boolean | — | HasDeploymentName says whether the deployment label is present. |
data.isSendingRequiredMetadata[].hasJobName | body | boolean | — | HasJobName says whether the job label is present. |
data.isSendingRequiredMetadata[].hasNamespaceName | body | boolean | — | HasNamespaceName says whether the namespace label is present. |
data.isSendingRequiredMetadata[].hasNodeName | body | boolean | — | HasNodeName says whether the node label is present. |
data.isSendingRequiredMetadata[].hasStatefulsetName | body | boolean | — | HasStatefulsetName says whether the statefulset label is present. |
data.isSendingRequiredMetadata[].namespaceName | body | string | — | NamespaceName is the pod's namespace. |
data.isSendingRequiredMetadata[].nodeName | body | string | — | NodeName is the pod's node. |
data.isSendingRequiredMetadata[].podName | body | string | — | PodName is the pod. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y infra_onboarding k8s statusimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11yInfraOnboardingK8sStatus();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_onboarding_k8s_status()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetO11yInfraOnboardingK8sStatus(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_onboarding_k8s_status(&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).getO11yInfraOnboardingK8sStatus();curl https://api.hanzo.ai/v1/o11y/infra_onboarding/k8s/status \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op get_o11y_infra_onboarding_k8s_status — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "o11y",
"arguments": {
"op": "get_o11y_infra_onboarding_k8s_status",
"input": {}
}
}
}'How is this guide?