OpenTelemetry Node.js SDK Wrapper

This is a simple wrapper for OpenTelemetry's Node.js SDK. It automatically configures tracing for popular Node.js libraries and exports the traces to an OpenTelemetry-compatible backend via the OTLP gRPC exporter.

Features

• Supports automatic instrumentation of various Node.js libraries.
• Easily configurable service name and log levels.
• Exports traces using OTLP gRPC exporter.
• Graceful shutdown on SIGTERM.

Supported Instrumentations

• HTTP
• Express
• MongoDB
• Socket.IO
• GraphQL
• Redis
• MySQL
• AWS SDK
• Mongoose
• File System (fs)
• System Metrics
• Node Runtime

Installation

npm install infrastack-interview-fs-ka
yarn add infrastack-interview-fs-ka

Usage

1. Import the Wrapper

import { register } from 'infrastack-interview-fs-ka';

2. Register Tracing with Configuration

Use the register function to initialize OpenTelemetry with your desired configuration.

register({
  endpoint: 'http://localhost:4317', // Your OTLP endpoint
  instruments: ['http', 'express', 'mongodb'], // List the libraries you want to instrument
  serviceName: 'my-node-service', // Optional: Define the service name
  logLevel: DiagLogLevel.DEBUG // Optional: Set the log level (DiagLogLevel)
});

3. Environment Setup

Make sure your OTLP backend (like Jaeger or a collector) is up and running. The endpoint should point to the trace receiver's gRPC endpoint.

Configuration Options

| Option | Type | Description | |----------------|----------|-----------------------------------------------------------------------------| | endpoint | string | The URL of your OTLP gRPC trace exporter. | | instruments | array | Array of libraries to auto-instrument (http, express, mongodb, etc.). | | serviceName | string | Optional: The name of your service (default: undefined). | | logLevel | number | Optional: The logging level for OpenTelemetry diagnostics (default: INFO). |

Example

import { register, DiagLogLevel } from 'infrastack-interview-fs-ka';

register({
    endpoint: 'http://localhost:4317',
    instruments: ['http', 'express', 'redis', 'system'],
    serviceName: 'my-awesome-service',
    logLevel: DiagLogLevel.DEBUG
});

Graceful Shutdown

The wrapper automatically handles shutdown when the process receives a SIGTERM signal. It will terminate the tracing process and clean up resources.

Logging

The logLevel parameter controls the verbosity of OpenTelemetry's internal logging. It can be set to any value from DiagLogLevel:

• DiagLogLevel.NONE
• DiagLogLevel.ERROR
• DiagLogLevel.WARN
• DiagLogLevel.INFO
• DiagLogLevel.DEBUG
• DiagLogLevel.VERBOSE

License

MIT