Skip to content

Observability

CAUTION

Observability must be treated as a first-class feature. This section is currently being developed and may be updated.

  • Logs must be structured JSON (Pino or Winston)
  • Include correlation IDs for request tracing
  • Use appropriate log levels (debug, info, warn, error)
  • Never log sensitive data (passwords, tokens, PII)
  • Dashboards are required for every production service
  • Must include key performance indicators
  • Should have clear ownership and maintenance schedule

Observability enables INFRA and on-call engineers to understand your service without having to read the code.

Good observability allows:

  • Faster incident response
  • Proactive identification of issues
  • Data-driven capacity planning
  • Clear understanding of service dependencies