Spring Boot Observability

Standards for Micrometer, Distributed Tracing, and Structured Logging

fierzone Updated

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

  • System.out: **No System.out**: Use Slf4j.
  • Public Actuator: **No Open Actuator**: Secure endpoints.
  • Custom Tracing: **No DIY Tracing**: Use Micrometer.

References

  • Implementation Examples

fierzone/agent-skills-standard/tree/main/skills/spring-boot/observability commit 2b90b12b75

Frequently asked questions

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