@ogcio/o11y-sdk-node 0.1.0-beta.2 → 0.1.0-beta.4

package/lib/instrumentation.node.ts

@@ -1,12 +1,14 @@
-import { NodeSDK } from "@opentelemetry/sdk-node";
+import { NodeSDK, resources } from "@opentelemetry/sdk-node";
 import type { NodeSDKConfig } from "./index.js";
 import type { Exporters } from "./options.js";
 import isUrl from "is-url";
 import buildHttpExporters from "./http.js";
 import buildGrpcExporters from "./grpc.js";
+import buildConsoleExporters from "./console.js";
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
 import { W3CTraceContextPropagator } from "@opentelemetry/core";
+import packageJson from "../package.json" with { type: "json" };
 
 export default function buildNodeInstrumentation(
   config?: NodeSDKConfig,
@@ -36,6 +38,8 @@ export default function buildNodeInstrumentation(
 
   if (config.protocol === "http") {
     exporter = buildHttpExporters(config);
+  } else if (config.protocol === "console") {
+    exporter = buildConsoleExporters(config);
   } else {
     exporter = buildGrpcExporters(config);
   }
@@ -49,6 +53,10 @@ export default function buildNodeInstrumentation(
     );
 
     const sdk = new NodeSDK({
+      resource: new resources.Resource({
+        "o11y.sdk.name": packageJson.name,
+        "o11y.sdk.version": packageJson.version,
+      }),
       serviceName: config.serviceName,
       traceExporter: exporter.traces,
       metricReader: exporter.metrics,

package/lib/metrics.ts

@@ -0,0 +1,70 @@
+import {
+  Counter,
+  createNoopMeter,
+  Gauge,
+  Histogram,
+  Meter,
+  MetricOptions,
+  metrics,
+  ObservableCounter,
+  ObservableGauge,
+  ObservableUpDownCounter,
+  UpDownCounter,
+} from "@opentelemetry/api";
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+declare const MetricsMap: {
+  gauge: Gauge;
+  histogram: Histogram;
+  counter: Counter;
+  updowncounter: UpDownCounter;
+  "async-counter": ObservableCounter;
+  "async-updowncounter": ObservableUpDownCounter;
+  "async-gauge": ObservableGauge;
+};
+
+type MetricType = keyof typeof MetricsMap;
+
+const MetricsFactoryMap: {
+  [K in MetricType]: (
+    meter: Meter,
+  ) => (name: string, options?: MetricOptions) => (typeof MetricsMap)[K];
+} = {
+  gauge: (meter: Meter) => meter.createGauge,
+  histogram: (meter: Meter) => meter.createHistogram,
+  counter: (meter: Meter) => meter.createCounter,
+  updowncounter: (meter: Meter) => meter.createUpDownCounter,
+  "async-counter": (meter: Meter) => meter.createObservableCounter,
+  "async-updowncounter": (meter: Meter) => meter.createObservableUpDownCounter,
+  "async-gauge": (meter: Meter) => meter.createObservableGauge,
+};
+
+export interface MetricsParams {
+  metricName: string;
+  attributeName: string;
+  options?: MetricOptions;
+}
+
+function getMeter({ metricName, attributeName }: MetricsParams) {
+  let meter: Meter;
+  if (!metricName || !attributeName) {
+    console.error("Invaid metric configuration!");
+    meter = createNoopMeter();
+  } else {
+    meter = metrics.getMeter(`custom_metric.${metricName}`);
+  }
+  return meter;
+}
+
+export function getMetric<T extends MetricType>(
+  type: T,
+  p: MetricsParams,
+): (typeof MetricsMap)[T] {
+  const meter = getMeter(p);
+
+  if (!MetricsFactoryMap[type]) {
+    throw new Error(`Unsupported metric type: ${type}`);
+  }
+
+  return MetricsFactoryMap[type](meter).bind(meter)(p.attributeName, p.options);
+}

package/lib/options.ts

@@ -1,8 +1,7 @@
-import type { MetricReader } from "@opentelemetry/sdk-metrics";
-import type { logs, tracing } from "@opentelemetry/sdk-node";
+import type { logs, tracing, metrics } from "@opentelemetry/sdk-node";
 
 export type Exporters = {
   traces: tracing.SpanExporter;
-  metrics: MetricReader;
+  metrics: metrics.MetricReader;
   logs: logs.LogRecordProcessor[];
 };

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "@ogcio/o11y-sdk-node",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.4",
   "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
   "main": "dist/index.js",
   "type": "module",
-  "scripts": {
-    "build": "rm -rf dist && tsc -p tsconfig.json",
-    "test": "vitest"
-  },
   "exports": {
     ".": "./dist/index.js",
     "./*": "./dist/*.js"
@@ -24,26 +20,30 @@
   "license": "ISC",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.53.0",
-    "@opentelemetry/core": "1.28.0",
-    "@opentelemetry/exporter-logs-otlp-grpc": "^0.55.0",
-    "@opentelemetry/exporter-logs-otlp-http": "^0.55.0",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.55.0",
-    "@opentelemetry/exporter-metrics-otlp-http": "^0.55.0",
-    "@opentelemetry/exporter-trace-otlp-grpc": "^0.55.0",
-    "@opentelemetry/exporter-trace-otlp-http": "^0.55.0",
-    "@opentelemetry/instrumentation": "^0.55.0",
-    "@opentelemetry/otlp-exporter-base": "^0.55.0",
-    "@opentelemetry/sdk-metrics": "^1.28.0",
-    "@opentelemetry/sdk-node": "^0.55.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.55.3",
+    "@opentelemetry/core": "1.30.1",
+    "@opentelemetry/exporter-logs-otlp-grpc": "^0.57.1",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.57.1",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "^0.57.1",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.57.1",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.57.1",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.57.1",
+    "@opentelemetry/instrumentation": "^0.57.1",
+    "@opentelemetry/otlp-exporter-base": "^0.57.1",
+    "@opentelemetry/sdk-metrics": "^1.30.1",
+    "@opentelemetry/sdk-node": "^0.57.1",
     "is-url": "^1.2.4"
   },
   "devDependencies": {
     "@types/is-url": "^1.2.32",
-    "@types/node": "^22.10.0",
-    "@vitest/coverage-v8": "^2.1.6",
+    "@types/node": "^22.12.0",
+    "@vitest/coverage-v8": "^3.0.4",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.6"
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.4"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "test": "vitest"
   }
-}
+}

package/test/metrics.test.ts

@@ -0,0 +1,142 @@
+import { describe, test, expect, vi, beforeEach, assert } from "vitest";
+import { getMetric, MetricsParams } from "../lib/metrics";
+
+const mockMeter = {
+  createGauge: vi.fn(),
+  createHistogram: vi.fn(),
+  createCounter: vi.fn(),
+  createUpDownCounter: vi.fn(),
+  createObservableCounter: vi.fn(),
+  createObservableUpDownCounter: vi.fn(),
+  createObservableGauge: vi.fn(),
+};
+
+vi.mock("@opentelemetry/api", async () => {
+  const { createNoopMeter } = await import("@opentelemetry/api");
+
+  return {
+    metrics: {
+      getMeter: vi.fn(() => mockMeter),
+    },
+    createNoopMeter: createNoopMeter,
+  };
+});
+
+describe("MetricsFactoryMap", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  const validMetricParams: MetricsParams = {
+    metricName: "test-metric",
+    attributeName: "test-attribute",
+    options: { description: "A test metric" },
+  };
+
+  test("should call createGauge when type is 'gauge'", () => {
+    mockMeter.createGauge.mockReturnValue("mocked-gauge");
+
+    const result = getMetric("gauge", validMetricParams);
+
+    expect(result).toBe("mocked-gauge");
+    expect(mockMeter.createGauge).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createHistogram when type is 'histogram'", () => {
+    mockMeter.createHistogram.mockReturnValue("mocked-histogram");
+
+    const result = getMetric("histogram", validMetricParams);
+
+    expect(result).toBe("mocked-histogram");
+    expect(mockMeter.createHistogram).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createCounter when type is 'counter'", () => {
+    mockMeter.createCounter.mockReturnValue("mocked-counter");
+
+    const result = getMetric("counter", validMetricParams);
+
+    expect(result).toBe("mocked-counter");
+    expect(mockMeter.createCounter).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createUpDownCounter when type is 'updowncounter'", () => {
+    mockMeter.createUpDownCounter.mockReturnValue("mocked-updowncounter");
+
+    const result = getMetric("updowncounter", validMetricParams);
+
+    expect(result).toBe("mocked-updowncounter");
+    expect(mockMeter.createUpDownCounter).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createObservableCounter when type is 'async-counter'", () => {
+    mockMeter.createObservableCounter.mockReturnValue("mocked-async-counter");
+
+    const result = getMetric("async-counter", validMetricParams);
+
+    expect(result).toBe("mocked-async-counter");
+    expect(mockMeter.createObservableCounter).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createObservableUpDownCounter when type is 'async-updowncounter'", () => {
+    mockMeter.createObservableUpDownCounter.mockReturnValue(
+      "mocked-async-updowncounter",
+    );
+
+    const result = getMetric("async-updowncounter", validMetricParams);
+
+    expect(result).toBe("mocked-async-updowncounter");
+    expect(mockMeter.createObservableUpDownCounter).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should call createObservableGauge when type is 'async-gauge'", () => {
+    mockMeter.createObservableGauge.mockReturnValue("mocked-async-gauge");
+
+    const result = getMetric("async-gauge", validMetricParams);
+
+    expect(result).toBe("mocked-async-gauge");
+    expect(mockMeter.createObservableGauge).toHaveBeenCalledWith(
+      validMetricParams.attributeName,
+      validMetricParams.options,
+    );
+  });
+
+  test("should throw an error for unsupported metric types", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const invalidMetricType = "invalid-type" as any;
+
+    expect(() => getMetric(invalidMetricType, validMetricParams)).toThrow(
+      `Unsupported metric type: ${invalidMetricType}`,
+    );
+  });
+
+  test("should return noop metric fallback for null config", async () => {
+    const nullMetricParams: MetricsParams = {
+      metricName: null!,
+      attributeName: "",
+    };
+
+    const result = getMetric("async-gauge", nullMetricParams);
+
+    assert.isNotNull(result);
+    assert.equal(result.constructor.name, "NoopObservableGaugeMetric");
+  });
+});

package/test/node-config.test.ts

@@ -1,6 +1,6 @@
 import { test, describe, assert, expect } from "vitest";
 import buildNodeInstrumentation from "../lib/instrumentation.node.js";
-import { NodeSDK, logs } from "@opentelemetry/sdk-node";
+import { NodeSDK, logs, metrics, tracing } from "@opentelemetry/sdk-node";
 import { OTLPTraceExporter as GRPC_OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
 import { OTLPMetricExporter as GRPC_OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
 import { OTLPLogExporter as GRPC_OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
@@ -32,10 +32,7 @@ describe("verify config settings", () => {
     assert.equal(_configuration.serviceName, commonConfig.serviceName);
 
     const traceExporter = _configuration.traceExporter;
-    assert.equal(
-      traceExporter["_transport"]["_parameters"]["compression"],
-      "gzip",
-    );
+
     assert.ok(traceExporter instanceof GRPC_OTLPTraceExporter);
 
     const logRecordProcessors = _configuration.logRecordProcessors;
@@ -64,10 +61,6 @@ describe("verify config settings", () => {
     assert.equal(_configuration.serviceName, commonConfig.serviceName);
 
     const traceExporter = _configuration.traceExporter;
-    assert.equal(
-      traceExporter._transport._transport._parameters.compression,
-      "gzip",
-    );
     assert.ok(traceExporter instanceof HTTP_OTLPTraceExporter);
 
     const logRecordProcessors = _configuration.logRecordProcessors;
@@ -82,6 +75,39 @@ describe("verify config settings", () => {
     assert.ok(metricReader._exporter instanceof HTTP_OTLPMetricExporter);
   });
 
+  test("console - console config", () => {
+    const config: NodeSDKConfig = {
+      ...commonConfig,
+      protocol: "console",
+      diagLogLevel: "NONE",
+    };
+
+    const sdk: NodeSDK | undefined = buildNodeInstrumentation(config);
+    assert.ok(sdk);
+
+    const _configuration = sdk["_configuration"];
+    assert.equal(_configuration.serviceName, commonConfig.serviceName);
+
+    const traceExporter = _configuration.traceExporter;
+
+    assert.ok(traceExporter instanceof tracing.ConsoleSpanExporter);
+    assert.isUndefined(traceExporter._transport);
+
+    const logRecordProcessors = _configuration.logRecordProcessors;
+    assert.equal(logRecordProcessors.length, 1);
+
+    assert.ok(logRecordProcessors[0] instanceof logs.SimpleLogRecordProcessor);
+    assert.ok(
+      logRecordProcessors[0]["_exporter"] instanceof
+        logs.ConsoleLogRecordExporter,
+    );
+    assert.isUndefined(logRecordProcessors[0]["_exporter"]._transport);
+
+    const metricReader = _configuration.metricReader;
+    assert.ok(metricReader._exporter instanceof metrics.ConsoleMetricExporter);
+    assert.isUndefined(metricReader._exporter._transport);
+  });
+
   test("single log sending config", () => {
     const config: NodeSDKConfig = {
       ...commonConfig,

package/test/validation.test.ts

@@ -63,4 +63,35 @@ describe("validation config: should return without breaking the execution", () =
     );
     expect(consoleLogSpy).not.toHaveBeenCalled();
   });
+
+  test("node instrumentation: verify no instrumentation if exception occurs", () => {
+    let sdk: NodeSDK | undefined = undefined;
+
+    const consoleErrorSpy = vi
+      .spyOn(console, "error")
+      .mockImplementation(vi.fn());
+    const consoleLogSpy = vi.spyOn(console, "log").mockImplementation(vi.fn());
+
+    vi.mock("@opentelemetry/auto-instrumentations-node", () => ({
+      getNodeAutoInstrumentations: vi.fn(() => {
+        throw new Error("Wanted error");
+      }),
+    }));
+
+    assert.doesNotThrow(() => {
+      sdk = buildNodeInstrumentation({
+        collectorUrl: "https://testurl.com",
+        serviceName: "test",
+      });
+    });
+
+    assert.equal(sdk, undefined);
+
+    expect(consoleErrorSpy).toHaveBeenCalled();
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "Error starting NodeJS OpenTelemetry instrumentation:",
+      new Error("Wanted error"),
+    );
+    expect(consoleLogSpy).not.toHaveBeenCalled();
+  });
 });

package/test-report.xml

@@ -1,39 +1,71 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<testsuites name="vitest tests" tests="9" failures="0" errors="0" time="0.781">
-    <testsuite name="test/index.test.ts" timestamp="2024-11-26T09:25:25.586Z" hostname="ABozzelli-ITMAC24" tests="2" failures="0" errors="0" skipped="0" time="0.002388">
-        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should call buildNodeInstrumentation with the provided config" time="0.001363792">
+<testsuites name="vitest tests" tests="20" failures="0" errors="0" time="0.189321701">
+    <testsuite name="test/index.test.ts" timestamp="2025-01-28T15:28:22.386Z" hostname="fv-az367-418" tests="2" failures="0" errors="0" skipped="0" time="0.008525973">
+        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should call buildNodeInstrumentation with the provided config" time="0.004943385">
         </testcase>
-        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should not throw when called without arguments" time="0.000454542">
+        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should not throw when called without arguments" time="0.001780995">
         </testcase>
     </testsuite>
-    <testsuite name="test/node-config.test.ts" timestamp="2024-11-26T09:25:25.587Z" hostname="ABozzelli-ITMAC24" tests="4" failures="0" errors="0" skipped="0" time="0.042719333">
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; grpc config" time="0.017177333">
+    <testsuite name="test/metrics.test.ts" timestamp="2025-01-28T15:28:22.388Z" hostname="fv-az367-418" tests="9" failures="0" errors="0" skipped="0" time="0.016880947">
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createGauge when type is &apos;gauge&apos;" time="0.005396083">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createHistogram when type is &apos;histogram&apos;" time="0.000557498">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createCounter when type is &apos;counter&apos;" time="0.000447099">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createUpDownCounter when type is &apos;updowncounter&apos;" time="0.000433999">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createObservableCounter when type is &apos;async-counter&apos;" time="0.000520098">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createObservableUpDownCounter when type is &apos;async-updowncounter&apos;" time="0.000518598">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should call createObservableGauge when type is &apos;async-gauge&apos;" time="0.000397299">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should throw an error for unsupported metric types" time="0.001743294">
+        </testcase>
+        <testcase classname="test/metrics.test.ts" name="MetricsFactoryMap &gt; should return noop metric fallback for null config" time="0.004466986">
+            <system-err>
+Invaid metric configuration!
+
+            </system-err>
+        </testcase>
+    </testsuite>
+    <testsuite name="test/node-config.test.ts" timestamp="2025-01-28T15:28:22.391Z" hostname="fv-az367-418" tests="5" failures="0" errors="0" skipped="0" time="0.146814435">
+        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; grpc config" time="0.056207422">
+            <system-out>
+NodeJS OpenTelemetry instrumentation started successfully.
+
+            </system-out>
+        </testcase>
+        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; http config" time="0.04112677">
             <system-out>
 NodeJS OpenTelemetry instrumentation started successfully.
 
             </system-out>
         </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; http config" time="0.016206917">
+        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; console - console config" time="0.01881204">
             <system-out>
 NodeJS OpenTelemetry instrumentation started successfully.
 
             </system-out>
         </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; single log sending config" time="0.008346875">
+        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; single log sending config" time="0.027214414">
             <system-out>
 NodeJS OpenTelemetry instrumentation started successfully.
 
             </system-out>
         </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; check if clear base endpoint final slash" time="0.000374">
+        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; check if clear base endpoint final slash" time="0.001299795">
         </testcase>
     </testsuite>
-    <testsuite name="test/validation.test.ts" timestamp="2024-11-26T09:25:25.587Z" hostname="ABozzelli-ITMAC24" tests="3" failures="0" errors="0" skipped="0" time="0.003302375">
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; should call buildNodeInstrumentation without config and skip instrumentation" time="0.00188275">
+    <testsuite name="test/validation.test.ts" timestamp="2025-01-28T15:28:22.394Z" hostname="fv-az367-418" tests="4" failures="0" errors="0" skipped="0" time="0.017100346">
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; should call buildNodeInstrumentation without config and skip instrumentation" time="0.005204683">
+        </testcase>
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: url undefined" time="0.002382393">
         </testcase>
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: url undefined" time="0.000551875">
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: invalid url" time="0.000839897">
         </testcase>
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: invalid url" time="0.000253958">
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: verify no instrumentation if exception occurs" time="0.006574379">
         </testcase>
     </testsuite>
 </testsuites>

package/tsconfig.json

@@ -8,7 +8,8 @@
     "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
     "strict": true /* Enable all strict type-checking options. */,
     "skipLibCheck": true /* Skip type checking all .d.ts files. */,
-    "declaration": true
+    "declaration": true,
+    "resolveJsonModule": true
   },
   "exclude": ["**/test/**"]
 }