log-design

What problem does it solve?

Provides clear guidance to design and review application logging so teams can reliably investigate incidents, reduce noisy logs, and ensure logs integrate with observability tooling.

Core Features & Use Cases

• Canonical Log Line: Encourage a single, structured log entry per request to centralize context and avoid duplication.
• Structured Logging & Field Hygiene: Recommend separating data into fields, managing field names as constants, and enabling efficient filtering and metric extraction.
• Log Level Strategy & Classification: Define how to use DEBUG/INFO/WARN/ERROR and align levels with monitoring and alerting to prevent alert fatigue.
• Telemetry Integration: Advise including trace ID/span ID for correlation with traces and metrics and guidance for deriving metrics from logs.
• Security & Privacy: Enforce exclusion or masking of PII and secrets and recommend environment-specific logging settings.
• Review Checklist: A practical checklist for design, content, and observability readiness when auditing or creating logging for services.

Quick Start

Ask the skill to review a service's logging design and produce a prioritized checklist of missing fields, level adjustments, and telemetry correlation steps.