code-check-observability-coverage

Audit changed code for observability coverage gaps and produce severity-ranked findings.

22|3|Updated Jul 28, 2024
One-click install
npx skills add https://github.com/webdevcody/go-mailing-list --skill code-check-observability-coverage
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-check-observability-coverage
Source: https://github.com/webdevcody/go-mailing-list/tree/main/.claude/skills/code-check-observability-coverage
Command: npx skills add https://github.com/webdevcody/go-mailing-list --skill code-check-observability-coverage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It identifies missing or unreliable observability in changed code so you can prevent “mysterious failures” and debugging blind spots in production.

Core Features & Use Cases

  • Read-only coverage audit: Detects logging gaps, swallowed errors, missing correlation IDs, PII leakage in logs, and missing latency/failure metrics without auto-instrumenting.
  • Change-scoped analysis: Focuses on critical-path code and newly added/modified server entry points, webhooks, and background jobs to reduce noise.
  • Severity-ranked findings: Reports HIGH/MEDIUM/LOW findings with file and line references to guide safe follow-up work.
  • Logger-aware guidance: Detects which logging framework the repo uses and recommends fixes that match that existing setup.

Quick Start

Run the observability coverage audit after critical-path changes (server functions, route handlers, webhooks, or background jobs) to get a severity-ranked report of logging, error-handling, correlation, PII, and metrics gaps.

Frequently Asked Questions about code-check-observability-coverage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find missing logging and error handling in new server endpoints?

To find missing logging and error handling in new server endpoints, run an observability coverage audit on changed code. It detects logging gaps, swallowed errors, and missing correlation IDs, producing a severity-ranked findings report with file and line references.

How do I check if PII is leaking into my application logs?

To check if PII is leaking into application logs, audit changed code for observability coverage gaps. The audit specifically scans for PII leakage in logs within modified server entry points and background jobs, reporting findings by severity.

Does the observability audit work with my existing logging framework?

Yes, the observability audit detects the repo's existing logger and error reporter. It provides read-only, logger-aware guidance that matches your current setup without auto-instrumenting or modifying your code.

What is the best way to review observability coverage for background jobs?

The best way to review observability coverage for background jobs is to run a change-scoped audit. It focuses on newly added or modified critical paths, identifying missing latency metrics, structured logging gaps, and error reporting issues.

When should I not use automated instrumentation for observability gaps?

Avoid automated instrumentation when you need a safe, read-only assessment first. This audit produces a severity-ranked findings report of observability gaps without auto-instrumenting, guiding manual follow-up work on critical paths and error flows.