otel-audit

What problem does it solve?

It helps you quickly identify what OpenTelemetry instrumentation already exists in a codebase and exactly what’s missing, so you can avoid guesswork before making changes.

Core Features & Use Cases

• Repository-wide instrumentation discovery: Detects the language/framework, enumerates HTTP routes, and records concrete evidence paths (manifests, entry points, route sources, and runtime/startup files).
• Signal-level audit for spans, metrics, and logs: Produces explicit inventories of span sources (including individual span names), metric names, and log integration details (e.g., trace-context injection).
• RED (Rate, Errors, Duration) gap analysis with anti-pattern detection: Classifies whether each RED dimension is covered, partial, or missing and flags common pitfalls like missing context propagation and SDK misconfiguration.
• Generates a ready-to-read report: Writes the results to .observe/otel.md in the scanned service root, plus a concise chat summary that points to the report.

Quick Start

Run otel-audit from your service folder to create .observe/otel.md with a read-only observability coverage scan and recommendations for what to instrument next.