Spring Boot Observability

Standards for Micrometer, Distributed Tracing, and Structured Logging. Use when adding Micrometer metrics, distributed tracing, or structured logging to Spring Boot. (triggers: logback-spring.xml, application.properties, micrometer, tracing, correlation-id, mdc)

ComeOnOliver Updated 61 repo stars

File contents

Spring Boot Observability

Priority: P0

Implementation Guidelines

Distributed Tracing

  • Correlation IDs: Enable trace/span ID injection.
  • Propagation: Propagate context across threads (@Async) and clients.
  • OpenTelemetry: Use OTel bridge (micrometer-tracing-bridge-otel).

Structured Logging

  • Format: Use JSON logging (logstash-logback-encoder) in production.
  • MDC: Use MDC for contextual info (userId, tenantId).
  • Output: Log to stdout only. Let container handle shipping.

Actuator

  • Security: Secure /actuator/** with Admin role.
  • Probes: Enable K8s Liveness/Readiness probes.

Anti-Patterns

  • No System.out: Use @Slf4j for all structured logging.
  • No open Actuator: Secure /actuator/** with Admin role.
  • No DIY tracing: Use Micrometer with OTel bridge.

References

  • Implementation Examples

ComeOnOliver/skillshub/tree/main/skills/HoangNguyen0403/agent-skills-standard/spring-boot-observability commit 7897a84ce6

Frequently asked questions

npx skillmds@latest add comeonoliver/spring-boot-observability