Observability Guide

MyCLI generates a full observability stack: structured logging, metrics, distributed tracing, error monitoring, and alerting.

Setup

my add observability --logger pino
my add observability --logger winston

Components

Logging

• Structured JSON logging (Pino or Winston)
• Request/response correlation IDs
• Log levels and context propagation

Metrics

• Prometheus-compatible metrics endpoint (/metrics)
• HTTP request duration, error rates, active connections
• Custom business metrics support

Tracing

• OpenTelemetry SDK integration
• Automatic HTTP/DB instrumentation
• Trace context propagation

Error Monitoring

• Sentry integration (optional)
• Datadog APM support (optional)
• Unhandled error capture with stack traces

Alerting

• Configurable alert rules
• Health check endpoint (/health)

Generated Files

• src/modules/observability/logging/ — Logger setup and middleware
• src/modules/observability/metrics/ — Prometheus registry and collectors
• src/modules/observability/tracing/ — OpenTelemetry SDK bootstrap
• src/modules/observability/errors/ — Error monitoring integration
• src/modules/observability/alerts/ — Alert rule definitions
• src/modules/observability/correlation.ts — Request correlation ID middleware

Environment Variables

OTEL_SERVICE_NAME=my-app
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
SENTRY_DSN=
DD_SITE=datadoghq.com
LOG_LEVEL=info