Skip to main content

OTEL-012: health_check configured but not listed in service.extensions

Severity: warn (advisory)

Rule Details​

In the Collector config, an extension has to be declared in extensions: and referenced in service.extensions: before it starts. It is very easy to write the health_check block and then forget the second step — the config validates, the extension does nothing, and probes silently fail.

This rule fires when extensions.health_check exists but health_check is not present in service.extensions.

Options​

This rule has no options.

Examples​

Avoid
extensions:
  health_check:
    endpoint: "localhost:13133"

service:
  extensions: []            # health_check not enabled
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [otlp/backend]
Prefer
extensions:
  health_check:
    endpoint: "localhost:13133"

service:
  extensions: [health_check]
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [otlp/backend]

When Not To Use It​

Never — this rule catches a near-universal copy/paste mistake. If you do not want health_check running, delete the extensions.health_check block entirely.

  • OTEL-011 — health_check extension recommended
  • OTEL-062 — extension in service.extensions but not defined

Version​

Available since augur v0.1.0.

Further Reading​

Resources​