sm-utility 2.3.8 → 2.4.1

package/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./stubs"), exports);
 __exportStar(require("./thread"), exports);
 __exportStar(require("./excel"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./tracing"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.3.8",
+  "version": "2.4.1",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -27,6 +27,14 @@
   },
   "dependencies": {
     "@elastic/ecs-winston-format": "^1.3.1",
+    "@opentelemetry/auto-instrumentations-node": "0.55.3",
+    "@opentelemetry/exporter-trace-otlp-http": "0.57.1",
+    "@opentelemetry/id-generator-aws-xray": "1.2.2",
+    "@opentelemetry/instrumentation-express": "0.47.0",
+    "@opentelemetry/propagator-aws-xray": "1.26.1",
+    "@opentelemetry/resources": "1.30.1",
+    "@opentelemetry/sdk-node": "0.57.1",
+    "@opentelemetry/sdk-trace-base": "1.30.1",
     "aws-sdk": "^2.1134.0",
     "axios": "^1.6.8",
     "express-winston": "^4.1.0",

package/tracing/index.d.ts

@@ -0,0 +1,2 @@
+export { OpenTelemetryTracer } from "./opentelemetry-tracer";
+export type { TracingConfig } from "./opentelemetry-tracer";

package/tracing/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenTelemetryTracer = void 0;
+var opentelemetry_tracer_1 = require("./opentelemetry-tracer");
+Object.defineProperty(exports, "OpenTelemetryTracer", { enumerable: true, get: function () { return opentelemetry_tracer_1.OpenTelemetryTracer; } });

package/tracing/opentelemetry-tracer.d.ts

@@ -0,0 +1,15 @@
+export interface TracingConfig {
+    serviceName: string;
+    environment: string;
+    otelEndpoint: string;
+    samplingRatio?: number;
+    maxQueueSize?: number;
+    scheduledDelayMillis?: number;
+    ignoredPaths?: (string | RegExp | ((url: string) => boolean))[];
+}
+export declare class OpenTelemetryTracer {
+    private sdk;
+    constructor(config: TracingConfig);
+    start(): void;
+    private setupGracefulShutdown;
+}

package/tracing/opentelemetry-tracer.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenTelemetryTracer = void 0;
+const sdk_node_1 = require("@opentelemetry/sdk-node");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const auto_instrumentations_node_1 = require("@opentelemetry/auto-instrumentations-node");
+const exporter_trace_otlp_http_1 = require("@opentelemetry/exporter-trace-otlp-http");
+const resources_1 = require("@opentelemetry/resources");
+const id_generator_aws_xray_1 = require("@opentelemetry/id-generator-aws-xray");
+const propagator_aws_xray_1 = require("@opentelemetry/propagator-aws-xray");
+const logger_1 = require("../logger");
+const DEFAULT_CONFIG = {
+    samplingRatio: 0.1,
+    maxQueueSize: 50,
+    scheduledDelayMillis: 1000,
+};
+class OpenTelemetryTracer {
+    constructor(config) {
+        const finalConfig = { ...DEFAULT_CONFIG, ...config };
+        const resource = resources_1.Resource.default().merge(new resources_1.Resource({
+            "service.name": finalConfig.serviceName,
+            "deployment.environment": finalConfig.environment,
+        }));
+        const traceExporter = new exporter_trace_otlp_http_1.OTLPTraceExporter({
+            url: finalConfig.otelEndpoint,
+        });
+        const spanProcessor = new sdk_trace_base_1.BatchSpanProcessor(traceExporter, {
+            maxQueueSize: finalConfig.maxQueueSize,
+            scheduledDelayMillis: finalConfig.scheduledDelayMillis,
+        });
+        this.sdk = new sdk_node_1.NodeSDK({
+            resource,
+            spanProcessors: [spanProcessor],
+            instrumentations: [
+                (0, auto_instrumentations_node_1.getNodeAutoInstrumentations)({
+                    "@opentelemetry/instrumentation-express": {
+                        enabled: true,
+                        ...(finalConfig.ignoredPaths && {
+                            ignoreIncomingPaths: finalConfig.ignoredPaths,
+                        }),
+                    },
+                }),
+            ],
+            textMapPropagator: new propagator_aws_xray_1.AWSXRayPropagator(),
+            idGenerator: new id_generator_aws_xray_1.AWSXRayIdGenerator(),
+            sampler: new sdk_trace_base_1.TraceIdRatioBasedSampler(finalConfig.samplingRatio),
+        });
+    }
+    start() {
+        this.sdk.start();
+        logger_1.logger.info("OpenTelemetry initialization completed");
+        this.setupGracefulShutdown();
+    }
+    setupGracefulShutdown() {
+        process.on("SIGTERM", () => {
+            this.sdk
+                .shutdown()
+                .then(() => logger_1.logger.info("Tracing terminated"))
+                .catch((error) => logger_1.logger.error("Error terminating tracing", { err: error }))
+                .finally(() => process.exit(0));
+        });
+    }
+}
+exports.OpenTelemetryTracer = OpenTelemetryTracer;