log-design

Review application logging designs for structured fields, log levels, and telemetry correlation.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/RyoMa99/dotfiles --skill log-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: log-design
Source: https://github.com/RyoMa99/dotfiles/tree/main/dot_claude/skills/log-design
Command: npx skills add https://github.com/RyoMa99/dotfiles --skill log-design

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about log-design

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

FAQPage Schema
What is a canonical log line and when do I need it for observability?

A canonical log line is a single, structured log entry per request that centralizes context and avoids duplication. You need it to improve observability and reliably investigate incidents without parsing scattered, noisy logs.

How do I design structured logging and manage log levels to prevent alert fatigue?

Design structured logging by separating data into constant fields for filtering, and manage log levels by aligning DEBUG/INFO/WARN/ERROR usage with monitoring rules to prevent alert fatigue and reduce noisy logs.

How do I correlate logs with traces using telemetry integration?

Correlate logs with traces by including trace ID and span ID in your structured log entries. This telemetry integration enables you to pivot between logs, metrics, and traces during incident investigation.

What is the best way to exclude PII and secrets from application logs?

The best way to exclude PII and secrets is to enforce masking rules and environment-specific logging settings. This security and privacy strategy ensures sensitive data is never exposed in production observability tooling.

Can I use a logging review checklist for production readiness auditing?

Yes, you can use a logging review checklist to audit production readiness. It evaluates design, content, and observability factors like missing fields, level adjustments, and telemetry correlation steps to ensure reliable incident investigation.

Why does deriving metrics from logs require structured field hygiene?

Deriving metrics from logs requires structured field hygiene because extracting numerical data depends on consistent field names. Managing field names as constants enables efficient filtering and reliable metric extraction from your telemetry.