Hanzo
OpenapiO11y

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

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/checks
MethodGET
Operationget_o11y_infra_monitoring_checks
AuthAuthorization: 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.

FieldInTypeRequiredDescription
typequerystringyesType is the section to check — hosts, processes, pods, nodes, deployments, daemonsets, statefulsets, jobs, namespaces, clusters or volumes.

Response

StatusBodyMeaning
200o11y.O11yInfraChecksOutok

200 body — 40 fields.

FieldInTypeAlwaysDescription
databodyo11y.Checks
data.missingDefaultEnabledMetricsbodyo11y.MissingMetricsComponentEntry[]
data.missingDefaultEnabledMetrics[].associatedComponentbodyo11y.AssociatedComponent
data.missingDefaultEnabledMetrics[].associatedComponent.namebodystring
data.missingDefaultEnabledMetrics[].associatedComponent.typebodyany
data.missingDefaultEnabledMetrics[].documentationLinkbodystring
data.missingDefaultEnabledMetrics[].messagebodystring
data.missingDefaultEnabledMetrics[].metricsbodystring[]
data.missingOptionalMetricsbodyo11y.MissingMetricsComponentEntry[]
data.missingOptionalMetrics[].associatedComponentbodyo11y.AssociatedComponent
data.missingOptionalMetrics[].associatedComponent.namebodystring
data.missingOptionalMetrics[].associatedComponent.typebodyany
data.missingOptionalMetrics[].documentationLinkbodystring
data.missingOptionalMetrics[].messagebodystring
data.missingOptionalMetrics[].metricsbodystring[]
data.missingRequiredAttributesbodyo11y.MissingAttributesComponentEntry[]
data.missingRequiredAttributes[].associatedComponentbodyo11y.AssociatedComponent
data.missingRequiredAttributes[].associatedComponent.namebodystring
data.missingRequiredAttributes[].associatedComponent.typebodyany
data.missingRequiredAttributes[].attributesbodystring[]
data.missingRequiredAttributes[].documentationLinkbodystring
data.missingRequiredAttributes[].messagebodystring
data.presentDefaultEnabledMetricsbodyo11y.MetricsComponentEntry[]
data.presentDefaultEnabledMetrics[].associatedComponentbodyo11y.AssociatedComponent
data.presentDefaultEnabledMetrics[].associatedComponent.namebodystring
data.presentDefaultEnabledMetrics[].associatedComponent.typebodyany
data.presentDefaultEnabledMetrics[].metricsbodystring[]
data.presentOptionalMetricsbodyo11y.MetricsComponentEntry[]
data.presentOptionalMetrics[].associatedComponentbodyo11y.AssociatedComponent
data.presentOptionalMetrics[].associatedComponent.namebodystring
data.presentOptionalMetrics[].associatedComponent.typebodyany
data.presentOptionalMetrics[].metricsbodystring[]
data.presentRequiredAttributesbodyo11y.AttributesComponentEntry[]
data.presentRequiredAttributes[].associatedComponentbodyo11y.AssociatedComponent
data.presentRequiredAttributes[].associatedComponent.namebodystring
data.presentRequiredAttributes[].associatedComponent.typebodyany
data.presentRequiredAttributes[].attributesbodystring[]
data.readybodyboolean
data.typebodyany
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y infra_monitoring checks --type <type>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page