Skip to main content

OTEL-011: health_check extension recommended

Severity: warn (advisory)

Rule Details​

Without the health_check extension there is no way for a liveness probe, readiness probe, or external load balancer to know whether the Collector is actually running. Pods hang on to traffic they cannot export, crash loops go undetected, and deploys look green when they are not. The extension is small, cheap, and universally useful.

This rule fires when the extensions.health_check block is missing.

Options​

This rule has no options.

Examples​

Avoid
extensions:
  pprof:
    endpoint: localhost:1777
# no health_check
Prefer
extensions:
  health_check:
    endpoint: "localhost:13133"

service:
  extensions: [health_check]

When Not To Use It​

Throwaway local runs where you are not using Kubernetes probes or any external health checker. In production, always enable it.

  • OTEL-012 — health_check configured but not listed in service.extensions
  • OTEL-062 — extension in service.extensions but not defined

Version​

Available since augur v0.1.0.

Further Reading​

Resources​