Hanzo
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

Addresshttps://api.hanzo.ai/v1/o11y/infra_onboarding/k8s/status
MethodGET
Operationget_o11y_infra_onboarding_k8s_status
AuthAuthorization: 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

StatusBodyMeaning
200o11y.O11yOnboardingOutok

200 body — 19 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yK8sOnboarding
data.didSendClusterMetricsbodybooleanDidSendClusterMetrics says whether cluster metrics have arrived.
data.didSendNodeMetricsbodybooleanDidSendNodeMetrics says whether node metrics have arrived.
data.didSendPodMetricsbodybooleanDidSendPodMetrics says whether pod metrics have arrived.
data.isSendingOptionalPodMetricsbodybooleanIsSendingOptionalPodMetrics says whether optional pod metrics are flowing.
data.isSendingRequiredMetadatabodyo11y.O11yPodOnboarding[]IsSendingRequiredMetadata reports, per pod, which required metadata labels are present.
data.isSendingRequiredMetadata[].clusterNamebodystringClusterName is the pod's cluster.
data.isSendingRequiredMetadata[].hasClusterNamebodybooleanHasClusterName says whether the cluster label is present.
data.isSendingRequiredMetadata[].hasCronjobNamebodybooleanHasCronjobName says whether the cronjob label is present.
data.isSendingRequiredMetadata[].hasDaemonsetNamebodybooleanHasDaemonsetName says whether the daemonset label is present.
data.isSendingRequiredMetadata[].hasDeploymentNamebodybooleanHasDeploymentName says whether the deployment label is present.
data.isSendingRequiredMetadata[].hasJobNamebodybooleanHasJobName says whether the job label is present.
data.isSendingRequiredMetadata[].hasNamespaceNamebodybooleanHasNamespaceName says whether the namespace label is present.
data.isSendingRequiredMetadata[].hasNodeNamebodybooleanHasNodeName says whether the node label is present.
data.isSendingRequiredMetadata[].hasStatefulsetNamebodybooleanHasStatefulsetName says whether the statefulset label is present.
data.isSendingRequiredMetadata[].namespaceNamebodystringNamespaceName is the pod's namespace.
data.isSendingRequiredMetadata[].nodeNamebodystringNodeName is the pod's node.
data.isSendingRequiredMetadata[].podNamebodystringPodName is the pod.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y infra_onboarding k8s status

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page