@qrvey/telemetry

Telemetry Package

This package provides telemetry instrumentation and logging for Qrvey services.

Environment Variables

Set the following environment variables to configure telemetry:

ENABLE_OTLP_LOG=true             # Enable OpenTelemetry logging
ENABLE_OTLP_TRACE=true           # Enable OpenTelemetry tracing
ENABLE_OTLP_METRIC=true          # Enable OpenTelemetry metrics
QRVEY_SERVICE_NAME=Qrvey-Service # Name of the service for telemetry identification
QRVEY_SERVICE_VERSION=1.0.0      # Version of the service
OTLP_TRACE_URL=http://localhost:4320/v1/traces   # Endpoint for sending trace data
OTLP_LOG_URL=http://localhost:4320/v1/logs       # Endpoint for sending log data
OTLP_METRIC_URL=http://otel-collector:4318/v1/metrics # Endpoint for sending metric data
ENABLE_CONSOLE_LOGS=false        # Enable or disable console logging
NODE_ENV=development             # Node.js environment (development, production, etc.)
LOG_LEVEL=debug                  # Minimum log level (debug, info, warn, error)

Usage

At the beginning of each service, start the InstrumentationService and use the LoggerService for logging purposes:

const { InstrumentationService, LoggerService } = require("@qrvey/telemetry");

// Initialize instrumentation
new InstrumentationService();

// Initialize logger (optional name for context)
const logger = new LoggerService('your_context_name');

logger.info("this is info message");
logger.debug("this is a debug message");
logger.warn("this is a warning message");
logger.error("this is an error message");

Notes

• Ensure all environment variables are set before starting your service.
• Use the logger for consistent log formatting and output.
• InstrumentationService should be initialized once at service startup.