OTEL-015: debug/logging exporter detected
Severity: warn (advisory)
Rule Details
The debug exporter (formerly logging) prints telemetry to stdout. It is invaluable during local development but in production it floods logs, pins CPU on serialization, and fills disks. A Collector with debug wired into a live pipeline is almost always a debugging leftover that should be removed.
This rule fires when an exporter named debug or logging is present in the exporters block.
Options
This rule has no options.
Examples
Avoid
exporters:
debug: {}
otlp/backend:
endpoint: backend:4317
service:
pipelines:
traces:
receivers: [otlp]
exporters: [debug, otlp/backend]
Prefer
exporters:
otlp/backend:
endpoint: backend:4317
service:
pipelines:
traces:
receivers: [otlp]
exporters: [otlp/backend]
When Not To Use It
Local development and ad-hoc debugging sessions. Use a separate config file for that case instead of shipping debug to production.
Related Rules
Version
Available since augur v0.1.0.
Further Reading
Resources
- Rule source:
policy/main/main.rego