What problem does it solve?
This Skill establishes clear guidelines and best practices for consistent, structured, and informative logging across applications, making debugging, monitoring, and analysis significantly easier.
Core Features & Use Cases
- Structured Logging: Enforces a consistent format for log messages, including timestamps, levels, correlation IDs, and contextual data.
- Log Level Guidance: Provides clear definitions and use cases for different log levels (TRACE, DEBUG, INFO, WARN, ERROR, FATAL).
- PII Masking: Details how to handle and mask Personally Identifiable Information (PII) in logs.
- Error & Performance Logging: Outlines requirements for logging errors and performance metrics effectively.
- Use Case: When developing a new microservice, use this Skill to ensure all log statements adhere to the defined standards, enabling seamless integration with the central logging system and quick identification of issues.
Quick Start
Use the logging-standards skill to review the current log statements in the codebase for adherence to structured logging best practices.