SKILL.md
Observability Standards
Structured Logging
- Standard: Use
nestjs-pinofor high-performance JSON logging.
- Why: Node's built-in console.log is blocking and unstructured.
- Configuration:
- Redaction: Mandatory masking of sensitive fields (password, token, email). - Context: Always inject Logger and set the context (LoginService).
Tracing (Correlation)
- Request ID: Every log line must include a
reqId(Request ID).
- nestjs-pino handles this automatically using AsyncLocalStorage. - Propagation: Pass x-request-id to downstream microservices/database queries key to trace flows.
Metrics
- Exposure: Use
@willsoto/nestjs-prometheusto expose/metricsfor Prometheus scraping. - Key Metrics:
1. httprequestdurationseconds (Histogram) 2. dbquerydurationseconds (Histogram) 3. memoryusagebytes (Gauge)
Health Checks
- Terminus: Implement explicit logic for "Liveness" (I'm alive) vs "Readiness" (I can take traffic).
- DB Check: TypeOrmHealthIndicator / PrismaHealthIndicator. - Memory Check: Fail if Heap > 300MB (prevent crash loops).