@safaricom-mxl/node-sdk
v0.0.4
Published
MXL Node.js OpenTelemetry SDK
Downloads
328
Maintainers
Readme
@safaricom-mxl/node-sdk
Server-side OpenTelemetry SDK for Node.js services.
Install
npm install @safaricom-mxl/node-sdkQuick start
import { initSDK } from '@safaricom-mxl/node-sdk';
initSDK({
serviceName: 'orders-api',
});CLI preload
opentelemetry-instrument ./dist/server.jsFramework helpers
- Express:
setupExpressErrorHandler - Koa:
setupKoaErrorHandler - Fastify:
setupFastifyErrorHandler - Nest:
createNestLogger
Logger adapters
- Pino:
getPinoTransport,getPinoMixinFunction - Winston:
getWinstonTransport
Environment variables
OTEL_SERVICE_NAMEOTEL_EXPORTER_OTLP_ENDPOINTOTEL_EXPORTER_OTLP_PROTOCOL(http/protobuf,http/json,grpc)OTEL_EXPORTER_OTLP_HEADERSOTEL_TRACES_SAMPLEROTEL_TRACES_SAMPLER_ARGMXL_NODE_ADVANCED_NETWORK_CAPTUREMXL_NODE_SENTRY_INTEGRATION_ENABLED
Troubleshooting
- Ensure collector protocol matches
OTEL_EXPORTER_OTLP_PROTOCOL. - If logs are missing, confirm
OTEL_LOGS_EXPORTERis not set tonone. - For preload mode in bundled apps, verify the preload command runs before app bootstrap.
