@webledger/opentelemetry-adonis

OpenTelemetry/SigNoz instrumentation package for AdonisJS applications.

Installation

npm install @webledger/opentelemetry-adonis

Usage

In your server.ts (or any early bootstrap file):

import { setupOpenTelemetry } from '@webledger/opentelemetry-adonis'

// Setup OpenTelemetry (only runs in production by default)
setupOpenTelemetry({
  serviceName: 'webledger-office-server',
  endpoint: process.env.OTEL_EXPORTER_OTLP_ENDPOINT!,
  environment: process.env.SYSTEM_ENV,
})

That's it! The package will:

• ✅ Initialize traces, metrics, and logs
• ✅ Auto-instrument HTTP, MySQL, Redis, AWS SDK, etc.
• ✅ Patch console methods to send logs to SigNoz
• ✅ Only run in production (when SYSTEM_ENV=production)

Configuration

interface OpenTelemetryConfig {
  serviceName: string        // Required: Service name for SigNoz
  endpoint: string           // Required: OTLP endpoint (e.g. 'http://signoz:4318')
  environment?: string        // Optional: Defaults to NODE_ENV
  serviceVersion?: string    // Optional: Defaults to npm_package_version
  productionOnly?: boolean    // Optional: Defaults to true
}

What You Get

• Traces: Automatic HTTP, DB, Redis, AWS spans
• Metrics: Service-level metrics (RPS, latency, errors)
• Logs: Console logs + Winston logs (if you use the provided logger)

Environment Variables

• OTEL_EXPORTER_OTLP_ENDPOINT - OTLP collector endpoint
• OTEL_SERVICE_NAME - Service name (can also be passed in config)
• SYSTEM_ENV - Must be production for instrumentation to run

License

MIT