logging-standards

Solid

Structured logging standards: log levels, structured fields, correlation IDs, PII masking, and event naming. TRIGGER when: adding log statements, configuring loggers, or reviewing log output. SKIP: metrics and alerting (use monitoring-observability); error control flow (use error-handling). (Examples use structlog + an OTLP sink.)

AI & Automation 15 stars 0 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
40
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Logging Standards Skill ## Purpose Standards for consistent, useful logging across all application layers. ## Auto-Invoke Triggers - Adding log statements - Configuring logging infrastructure - Debugging issues - Setting up monitoring --- ## Log Levels | Level | Use Case | Example | |-------|----------|---------| | **TRACE** | Detailed debugging | Variable values, loop iterations | | **DEBUG** | Diagnostic info | Method entry/exit, state changes | | **INFO** | Normal operations | Request completed, job started | | **WARN** | Potential issues | Retry attempt, deprecated usage | | **ERROR** | Failures | Exception caught, operation failed | | **FATAL** | System failure | Cannot start, out of memory | ### Level Selection Rules - Production default: INFO - Development default: DEBUG - Never log TRACE in production - ERROR should always have context --- ## Log Message Format ### Structure ``` [timestamp] [level] [correlation-id] [logger] - message {structured-data} ``` ### Example ``` 2024-01-15T10:30:45.123Z INFO abc-123-def UserService - User created {"userId": 42, "email": "user@example.com"} ``` ### Message Guidelines - Start with action verb: "Creating user", "Processing order" - Be specific: "User 123 deleted" not "Deleted" - Include relevant IDs - Keep messages concise --- ## Structured Logging ### Required Fields | Field | Description | Example | |-------|-------------|---------| | timestamp | ISO 8601 format | 2024-01-15T10:30:45.123Z | | level | Log level ...

Details

Author
komluk
Repository
komluk/scaffolding
Created
5 months ago
Last Updated
5 days ago
Language
Shell
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category