@ogcio/o11y-sdk-node 0.1.0-beta.12 → 0.1.0-beta.13

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.1.0-beta.13](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.1.0-beta.12...@ogcio/o11y-sdk-node@v0.1.0-beta.13) (2025-06-16)
+
+
+### Bug Fixes
+
+* **sdk-node:** allow graceful shutdown of instrumentation on SIGTERM AB[#28329](https://github.com/ogcio/o11y/issues/28329) ([#151](https://github.com/ogcio/o11y/issues/151)) ([991ee15](https://github.com/ogcio/o11y/commit/991ee1559898b721823cb9d1e0490e2ad82e6d0a))
+
 ## [0.1.0-beta.12](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.1.0-beta.11...@ogcio/o11y-sdk-node@v0.1.0-beta.12) (2025-06-04)
 
 

package/dist/lib/instrumentation.node.js

@@ -1,3 +1,4 @@
+import process from "process";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
 import { W3CTraceContextPropagator } from "@opentelemetry/core";
@@ -60,6 +61,16 @@ export default async function buildNodeInstrumentation(config) {
         });
         sdk.start();
         console.log("NodeJS OpenTelemetry instrumentation started successfully.");
+        process.on("SIGTERM", async () => {
+            try {
+                // Flushing before shutdown is implemented on a per-exporter basis.
+                await sdk.shutdown();
+                console.log("NodeJS OpenTelemetry instrumentation shutdown successfully");
+            }
+            catch (error) {
+                console.error("Error shutting down NodeJS OpenTelemetry instrumentation:", error);
+            }
+        });
         return sdk;
     }
     catch (error) {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ogcio/o11y-sdk-node",
-    "version": "0.1.0-beta.12",
+    "version": "0.1.0-beta.13",
     "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
     "main": "dist/index.js",
     "type": "module",
@@ -46,11 +46,11 @@
         "@opentelemetry/sdk-trace-base": "^2.0.1"
     },
     "devDependencies": {
-        "@types/node": "^22.15.29",
-        "@vitest/coverage-v8": "^3.2.1",
+        "@types/node": "^22.15.30",
+        "@vitest/coverage-v8": "^3.2.2",
         "tsx": "^4.19.4",
         "typescript": "^5.8.3",
-        "vitest": "^3.2.1"
+        "vitest": "^3.2.2"
     },
     "engines": {
         "node": ">=20.6.0"

package/dist/vitest.config.js

@@ -21,7 +21,7 @@ export default defineConfig({
         reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
         environment: "node",
         pool: "threads",
-        workspace: [
+        projects: [
             {
                 test: {
                     include: ["**/test/*.test.ts", "**/test/processor/*.test.ts"],

package/lib/instrumentation.node.ts

@@ -1,3 +1,4 @@
+import process from "process";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
 import { W3CTraceContextPropagator } from "@opentelemetry/core";
@@ -89,6 +90,22 @@ export default async function buildNodeInstrumentation(
 
     sdk.start();
     console.log("NodeJS OpenTelemetry instrumentation started successfully.");
+
+    process.on("SIGTERM", async () => {
+      try {
+        // Flushing before shutdown is implemented on a per-exporter basis.
+        await sdk.shutdown();
+        console.log(
+          "NodeJS OpenTelemetry instrumentation shutdown successfully",
+        );
+      } catch (error) {
+        console.error(
+          "Error shutting down NodeJS OpenTelemetry instrumentation:",
+          error,
+        );
+      }
+    });
+
     return sdk;
   } catch (error) {
     console.error(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/o11y-sdk-node",
-  "version": "0.1.0-beta.12",
+  "version": "0.1.0-beta.13",
   "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
   "main": "dist/index.js",
   "type": "module",
@@ -38,11 +38,11 @@
     "@opentelemetry/sdk-trace-base": "^2.0.1"
   },
   "devDependencies": {
-    "@types/node": "^22.15.29",
-    "@vitest/coverage-v8": "^3.2.1",
+    "@types/node": "^22.15.30",
+    "@vitest/coverage-v8": "^3.2.2",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
-    "vitest": "^3.2.1"
+    "vitest": "^3.2.2"
   },
   "engines": {
     "node": ">=20.6.0"

package/test/index.test.ts

@@ -1,10 +1,19 @@
-import { describe, test, expect, vi, beforeEach } from "vitest";
+import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
 import { NodeSDKConfig } from "../index";
 import { instrumentNode } from "../index";
 import * as buildNodeInstrumentationModule from "../lib/instrumentation.node";
+import { metrics } from "@opentelemetry/sdk-node";
 
 describe("instrumentNode", () => {
   beforeEach(() => {
+    // @ts-ignore Avoid actually running exporters at any time in tests (overriding private method)
+    vi.spyOn(
+      metrics.PeriodicExportingMetricReader.prototype,
+      "_doRun",
+    ).mockImplementation(vi.fn());
+  });
+
+  afterEach(() => {
     vi.restoreAllMocks();
   });
 
@@ -33,7 +42,29 @@ describe("instrumentNode", () => {
     expect(instrumentationMock).toHaveBeenCalledWith(config);
   });
 
-  test("should not throw when called without arguments", () => {
-    expect(instrumentNode()).resolves.not.toThrow();
+  test("should not throw when called without arguments", async () => {
+    await expect(instrumentNode()).resolves.not.toThrow();
+  });
+
+  test("should invoke instrumentation shutdown on SIGTERM", async () => {
+    const config: NodeSDKConfig = {
+      serviceName: "custom-service",
+      collectorUrl: "http://custom-collector.com",
+      protocol: "grpc",
+      resourceAttributes: {
+        "team.infra.cluster": "dev-01",
+        "team.infra.pod": "01",
+        "team.service.type": "fastify",
+      },
+      spanAttributes: {
+        "signal.namespace": "example",
+        "signal.number": () => "callback",
+      },
+    };
+
+    const sdk = await instrumentNode(config);
+    const shutdownMock = vi.spyOn(sdk, "shutdown");
+    process.emit("SIGTERM");
+    expect(shutdownMock).toHaveBeenCalled();
   });
 });

package/vitest.config.ts

@@ -22,7 +22,7 @@ export default defineConfig({
     reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
     environment: "node",
     pool: "threads",
-    workspace: [
+    projects: [
       {
         test: {
           include: ["**/test/*.test.ts", "**/test/processor/*.test.ts"],