monitoring-observability-standards

What problem does it solve?

This Skill provides clear guidelines and best practices for implementing effective monitoring and observability within software systems, ensuring better performance, faster debugging, and improved system reliability.

Core Features & Use Cases

• Structured Logging: Enforces the use of structured logging with key-value pairs for better aggregation and analysis.
• Log Levels: Defines appropriate usage for different log levels (ERROR, WARN, INFO, DEBUG, TRACE).
• Metrics Standards: Outlines best practices for Prometheus metrics (Counters, Gauges, Histograms) and warns against high-cardinality labels.
• Health Checks: Mandates the implementation of /health endpoints for system monitoring.
• Anti-Patterns: Lists common pitfalls to avoid in logging and metrics.
• Use Case: A development team can use these standards to ensure all new services are instrumented consistently, making it easier to correlate events across different parts of the system during an incident.

Quick Start

Follow the monitoring and observability standards outlined in this document for all new service development.