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

package/dist/lib/instrumentation.node.js

@@ -0,0 +1,62 @@
+import { NodeSDK, resources } from "@opentelemetry/sdk-node";
+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) {
+    if (!config) {
+        console.warn("observability config not set. Skipping NodeJS OpenTelemetry instrumentation.");
+        return;
+    }
+    if (!config.collectorUrl) {
+        console.warn("collectorUrl not set. Skipping NodeJS OpenTelemetry instrumentation.");
+        return;
+    }
+    if (!isUrl(config.collectorUrl)) {
+        console.error("collectorUrl does not use a valid format. Skipping NodeJS OpenTelemetry instrumentation.");
+        return;
+    }
+    let exporter;
+    if (config.protocol === "http") {
+        exporter = buildHttpExporters(config);
+    }
+    else if (config.protocol === "console") {
+        exporter = buildConsoleExporters(config);
+    }
+    else {
+        exporter = buildGrpcExporters(config);
+    }
+    try {
+        diag.setLogger(new DiagConsoleLogger(), config.diagLogLevel
+            ? DiagLogLevel[config.diagLogLevel]
+            : DiagLogLevel.INFO);
+        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,
+            logRecordProcessors: exporter.logs,
+            textMapPropagator: new W3CTraceContextPropagator(),
+            instrumentations: [
+                getNodeAutoInstrumentations({
+                    "@opentelemetry/instrumentation-fs": {
+                        enabled: config.enableFS ?? false,
+                    },
+                }),
+            ],
+        });
+        sdk.start();
+        console.log("NodeJS OpenTelemetry instrumentation started successfully.");
+        return sdk;
+    }
+    catch (error) {
+        console.error("Error starting NodeJS OpenTelemetry instrumentation:", error);
+    }
+}

package/dist/lib/metrics.d.ts

@@ -0,0 +1,18 @@
+import { Counter, Gauge, Histogram, MetricOptions, ObservableCounter, ObservableGauge, ObservableUpDownCounter, UpDownCounter } from "@opentelemetry/api";
+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;
+export interface MetricsParams {
+    metricName: string;
+    attributeName: string;
+    options?: MetricOptions;
+}
+export declare function getMetric<T extends MetricType>(type: T, p: MetricsParams): (typeof MetricsMap)[T];
+export {};

package/dist/lib/metrics.js

@@ -0,0 +1,28 @@
+import { createNoopMeter, metrics, } from "@opentelemetry/api";
+const MetricsFactoryMap = {
+    gauge: (meter) => meter.createGauge,
+    histogram: (meter) => meter.createHistogram,
+    counter: (meter) => meter.createCounter,
+    updowncounter: (meter) => meter.createUpDownCounter,
+    "async-counter": (meter) => meter.createObservableCounter,
+    "async-updowncounter": (meter) => meter.createObservableUpDownCounter,
+    "async-gauge": (meter) => meter.createObservableGauge,
+};
+function getMeter({ metricName, attributeName }) {
+    let meter;
+    if (!metricName || !attributeName) {
+        console.error("Invaid metric configuration!");
+        meter = createNoopMeter();
+    }
+    else {
+        meter = metrics.getMeter(`custom_metric.${metricName}`);
+    }
+    return meter;
+}
+export function getMetric(type, p) {
+    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/dist/lib/options.d.ts

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

package/dist/lib/options.js

@@ -0,0 +1 @@
+export {};

package/dist/lib/utils.d.ts

@@ -0,0 +1,3 @@
+import { SDKCollectorMode } from "./index.js";
+import { logs } from "@opentelemetry/sdk-node";
+export declare const LogRecordProcessorMap: Record<SDKCollectorMode, typeof logs.SimpleLogRecordProcessor | typeof logs.BatchLogRecordProcessor>;

package/dist/lib/utils.js

@@ -0,0 +1,5 @@
+import { logs } from "@opentelemetry/sdk-node";
+export const LogRecordProcessorMap = {
+    single: logs.SimpleLogRecordProcessor,
+    batch: logs.BatchLogRecordProcessor,
+};

package/dist/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "@ogcio/o11y-sdk-node",
+    "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",
+        "prepublishOnly": "pnpm i && pnpm build && pnpm test"
+    },
+    "exports": {
+        ".": "./dist/index.js",
+        "./*": "./dist/*.js"
+    },
+    "keywords": [
+        "observability",
+        "o11y",
+        "opentelemetry",
+        "node",
+        "nodejs",
+        "ogcio"
+    ],
+    "author": "team:ogcio/observability",
+    "license": "ISC",
+    "dependencies": {
+        "@opentelemetry/api": "^1.9.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.12.0",
+        "@vitest/coverage-v8": "^3.0.4",
+        "tsx": "^4.19.2",
+        "typescript": "^5.7.3",
+        "vitest": "^3.0.4"
+    }
+}

package/dist/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/dist/vitest.config.js

@@ -0,0 +1,25 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({
+    test: {
+        globals: true,
+        watch: false,
+        include: ["**/test/*.test.ts"],
+        exclude: ["**/fixtures/**", "**/dist/**"],
+        poolOptions: {
+            threads: {
+                maxThreads: 8,
+            },
+        },
+        clearMocks: true,
+        testTimeout: 30_000,
+        coverage: {
+            enabled: true,
+            provider: "v8",
+            reportsDirectory: "coverage",
+            reporter: ["lcov", "cobertura"],
+            clean: true,
+        },
+        reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
+        environment: "node",
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/o11y-sdk-node",
-  "version": "0.1.0-beta.3",
+  "version": "0.1.0-beta.4",
   "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
   "main": "dist/index.js",
   "type": "module",

package/test-report.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<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.001780995">
+        </testcase>
+    </testsuite>
+    <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; 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.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.001299795">
+        </testcase>
+    </testsuite>
+    <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: invalid url" time="0.000839897">
+        </testcase>
+        <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>