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

package/coverage/lcov.info

@@ -9,38 +9,62 @@ BRF:0
 BRH:0
 end_of_record
 TN:
+SF:lib/console.ts
+FN:5,buildConsoleExporters
+FNF:1
+FNH:1
+FNDA:1,buildConsoleExporters
+DA:1,1
+DA:5,1
+DA:6,1
+DA:7,1
+DA:8,1
+DA:9,1
+DA:10,1
+DA:11,1
+DA:12,1
+DA:13,1
+DA:14,1
+DA:15,1
+LF:12
+LH:12
+BRDA:5,0,0,1
+BRF:1
+BRH:1
+end_of_record
+TN:
 SF:lib/grpc.ts
 FN:10,buildGrpcExporters
 FNF:1
 FNH:1
-FNDA:2,buildGrpcExporters
+FNDA:3,buildGrpcExporters
 DA:1,1
-DA:10,2
-DA:11,2
-DA:12,2
-DA:13,2
-DA:14,2
-DA:15,2
-DA:16,2
-DA:17,2
-DA:18,2
-DA:19,2
-DA:20,2
-DA:21,2
-DA:22,2
-DA:23,2
-DA:24,2
-DA:25,2
-DA:26,2
-DA:27,2
-DA:28,2
-DA:29,2
-DA:30,2
-DA:31,2
+DA:10,3
+DA:11,3
+DA:12,3
+DA:13,3
+DA:14,3
+DA:15,3
+DA:16,3
+DA:17,3
+DA:18,3
+DA:19,3
+DA:20,3
+DA:21,3
+DA:22,3
+DA:23,3
+DA:24,3
+DA:25,3
+DA:26,3
+DA:27,3
+DA:28,3
+DA:29,3
+DA:30,3
+DA:31,3
 LF:23
 LH:23
-BRDA:10,0,0,2
-BRDA:23,1,0,1
+BRDA:10,0,0,3
+BRDA:23,1,0,2
 BRF:2
 BRH:2
 end_of_record
@@ -97,85 +121,167 @@ BRH:1
 end_of_record
 TN:
 SF:lib/instrumentation.node.ts
-FN:11,buildNodeInstrumentation
+FN:13,buildNodeInstrumentation
 FNF:1
 FNH:1
-FNDA:6,buildNodeInstrumentation
+FNDA:8,buildNodeInstrumentation
 DA:1,1
-DA:11,6
-DA:12,6
-DA:13,6
-DA:14,6
-DA:15,1
-DA:16,1
+DA:13,8
+DA:14,8
+DA:15,8
+DA:16,8
 DA:17,1
 DA:18,1
 DA:19,1
-DA:21,6
-DA:22,1
-DA:23,1
+DA:20,1
+DA:21,1
+DA:23,8
 DA:24,1
 DA:25,1
 DA:26,1
-DA:28,4
-DA:29,1
-DA:30,1
+DA:27,1
+DA:28,1
+DA:30,8
 DA:31,1
 DA:32,1
 DA:33,1
-DA:35,3
-DA:37,3
-DA:38,1
-DA:39,3
-DA:40,2
-DA:41,2
-DA:43,3
+DA:34,1
+DA:35,1
+DA:37,5
+DA:39,8
+DA:40,1
+DA:41,8
+DA:42,1
+DA:43,4
 DA:44,3
 DA:45,3
-DA:46,3
-DA:47,3
-DA:48,0
-DA:49,6
-DA:51,6
-DA:52,6
-DA:53,6
-DA:54,6
-DA:55,6
-DA:56,6
-DA:57,6
-DA:58,6
-DA:59,6
-DA:60,6
-DA:61,6
-DA:62,6
-DA:63,6
-DA:64,6
-DA:66,6
-DA:67,6
-DA:68,6
-DA:69,6
-DA:70,0
-DA:71,0
-DA:72,0
-DA:73,0
-DA:74,0
-DA:75,6
-LF:59
-LH:53
-BRDA:11,0,0,6
-BRDA:14,1,0,1
-BRDA:19,2,0,5
-BRDA:21,3,0,4
-BRDA:21,4,0,1
-BRDA:28,5,0,1
-BRDA:33,6,0,3
-BRDA:37,7,0,1
-BRDA:39,8,0,2
-BRDA:47,9,0,0
-BRDA:60,10,0,3
-BRDA:69,11,0,0
-BRF:12
-BRH:10
+DA:47,5
+DA:48,5
+DA:49,5
+DA:50,5
+DA:51,4
+DA:52,1
+DA:53,8
+DA:55,8
+DA:56,8
+DA:57,8
+DA:58,8
+DA:59,8
+DA:60,8
+DA:61,8
+DA:62,8
+DA:63,8
+DA:64,8
+DA:65,8
+DA:66,8
+DA:67,8
+DA:68,8
+DA:69,8
+DA:70,8
+DA:71,8
+DA:72,8
+DA:74,8
+DA:75,8
+DA:76,8
+DA:77,8
+DA:78,1
+DA:79,1
+DA:80,1
+DA:81,1
+DA:82,1
+DA:83,8
+LF:65
+LH:65
+BRDA:13,0,0,8
+BRDA:16,1,0,1
+BRDA:21,2,0,7
+BRDA:23,3,0,1
+BRDA:28,4,0,6
+BRDA:30,5,0,5
+BRDA:30,6,0,1
+BRDA:39,7,0,1
+BRDA:41,8,0,4
+BRDA:41,9,0,1
+BRDA:43,10,0,3
+BRDA:45,11,0,5
+BRDA:50,12,0,4
+BRDA:51,13,0,1
+BRDA:68,14,0,5
+BRDA:77,15,0,1
+BRF:16
+BRH:16
+end_of_record
+TN:
+SF:lib/metrics.ts
+FN:33,gauge
+FN:34,histogram
+FN:35,counter
+FN:36,updowncounter
+FN:37,async-counter
+FN:38,async-updowncounter
+FN:39,async-gauge
+FN:48,getMeter
+FN:59,getMetric
+FNF:9
+FNH:9
+FNDA:1,gauge
+FNDA:1,histogram
+FNDA:1,counter
+FNDA:1,updowncounter
+FNDA:1,async-counter
+FNDA:1,async-updowncounter
+FNDA:2,async-gauge
+FNDA:9,getMeter
+FNDA:9,getMetric
+DA:1,1
+DA:28,1
+DA:32,1
+DA:33,1
+DA:34,1
+DA:35,1
+DA:36,1
+DA:37,1
+DA:38,1
+DA:39,1
+DA:40,1
+DA:48,9
+DA:49,9
+DA:50,9
+DA:51,1
+DA:52,1
+DA:53,9
+DA:54,8
+DA:55,8
+DA:56,9
+DA:57,9
+DA:59,1
+DA:60,9
+DA:61,9
+DA:62,9
+DA:63,9
+DA:65,9
+DA:66,1
+DA:67,1
+DA:69,8
+DA:70,8
+LF:31
+LH:31
+BRDA:33,0,0,1
+BRDA:34,1,0,1
+BRDA:35,2,0,1
+BRDA:36,3,0,1
+BRDA:37,4,0,1
+BRDA:38,5,0,1
+BRDA:39,6,0,2
+BRDA:48,7,0,9
+BRDA:50,8,0,8
+BRDA:50,9,0,1
+BRDA:53,10,0,8
+BRDA:59,11,0,9
+BRDA:65,12,0,1
+BRDA:67,13,0,8
+BRF:14
+BRH:14
 end_of_record
 TN:
 SF:lib/options.ts

package/dist/index.d.ts

@@ -4,3 +4,4 @@ import buildNodeInstrumentation from "./lib/instrumentation.node.js";
 export type * from "./lib/index.js";
 export type { NodeSDKConfig, NodeSDK };
 export { buildNodeInstrumentation as instrumentNode };
+export * from "./lib/metrics.js";

package/dist/index.js

@@ -1,2 +1,3 @@
 import buildNodeInstrumentation from "./lib/instrumentation.node.js";
 export { buildNodeInstrumentation as instrumentNode };
+export * from "./lib/metrics.js";

package/dist/lib/console.d.ts

@@ -0,0 +1,3 @@
+import type { NodeSDKConfig } from "./index.js";
+import type { Exporters } from "./options.js";
+export default function buildConsoleExporters(_: NodeSDKConfig): Exporters;

package/dist/lib/console.js

@@ -0,0 +1,12 @@
+import { logs, metrics, tracing } from "@opentelemetry/sdk-node";
+export default function buildConsoleExporters(_) {
+    return {
+        traces: new tracing.ConsoleSpanExporter(),
+        metrics: new metrics.PeriodicExportingMetricReader({
+            exporter: new metrics.ConsoleMetricExporter(),
+        }),
+        logs: [
+            new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
+        ],
+    };
+}

package/dist/lib/grpc.js

@@ -1,16 +1,16 @@
 import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
 import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
-import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
 export default function buildGrpcExporters(config) {
     return {
         traces: new OTLPTraceExporter({
             url: `${config.collectorUrl}`,
             compression: CompressionAlgorithm.GZIP,
         }),
-        metrics: new PeriodicExportingMetricReader({
+        metrics: new metrics.PeriodicExportingMetricReader({
             exporter: new OTLPMetricExporter({
                 url: `${config.collectorUrl}`,
                 compression: CompressionAlgorithm.GZIP,

package/dist/lib/http.js

@@ -1,9 +1,9 @@
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
 import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
 export default function buildHttpExporters(config) {
     if (config.collectorUrl.endsWith("/")) {
         config.collectorUrl = config.collectorUrl.slice(0, -1);
@@ -13,7 +13,7 @@ export default function buildHttpExporters(config) {
             url: `${config.collectorUrl}/v1/traces`,
             compression: CompressionAlgorithm.GZIP,
         }),
-        metrics: new PeriodicExportingMetricReader({
+        metrics: new metrics.PeriodicExportingMetricReader({
             exporter: new OTLPMetricExporter({
                 url: `${config.collectorUrl}/v1/metrics`,
                 compression: CompressionAlgorithm.GZIP,

package/dist/lib/index.d.ts

@@ -34,13 +34,13 @@ export interface NodeSDKConfig extends SDKConfig {
      */
     enableFS?: boolean;
     /**
-     * http based connection protocol used to send signals.
+     * protocol used to send signals.
      *
      * @default grpc
      */
     protocol?: SDKProtocol;
 }
 export type SDKCollectorMode = "single" | "batch";
-export type SDKProtocol = "grpc" | "http";
+export type SDKProtocol = "grpc" | "http" | "console";
 export type SDKLogLevel = "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "VERBOSE" | "ALL";
 export {};

package/dist/lib/instrumentation.node.js

@@ -1,10 +1,12 @@
-import { NodeSDK } from "@opentelemetry/sdk-node";
+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.");
@@ -22,6 +24,9 @@ export default function buildNodeInstrumentation(config) {
     if (config.protocol === "http") {
         exporter = buildHttpExporters(config);
     }
+    else if (config.protocol === "console") {
+        exporter = buildConsoleExporters(config);
+    }
     else {
         exporter = buildGrpcExporters(config);
     }
@@ -30,6 +35,10 @@ export default function buildNodeInstrumentation(config) {
             ? 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,

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

@@ -1,7 +1,6 @@
-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/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/index.ts

@@ -5,3 +5,5 @@ import buildNodeInstrumentation from "./lib/instrumentation.node.js";
 export type * from "./lib/index.js";
 export type { NodeSDKConfig, NodeSDK };
 export { buildNodeInstrumentation as instrumentNode };
+
+export * from "./lib/metrics.js";

package/lib/console.ts

@@ -0,0 +1,15 @@
+import type { NodeSDKConfig } from "./index.js";
+import type { Exporters } from "./options.js";
+import { logs, metrics, tracing } from "@opentelemetry/sdk-node";
+
+export default function buildConsoleExporters(_: NodeSDKConfig): Exporters {
+  return {
+    traces: new tracing.ConsoleSpanExporter(),
+    metrics: new metrics.PeriodicExportingMetricReader({
+      exporter: new metrics.ConsoleMetricExporter(),
+    }),
+    logs: [
+      new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
+    ],
+  };
+}

package/lib/grpc.ts

@@ -1,11 +1,11 @@
 import type { NodeSDKConfig } from "./index.js";
 import type { Exporters } from "./options.js";
 import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
 import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
-import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
 
 export default function buildGrpcExporters(config: NodeSDKConfig): Exporters {
   return {
@@ -13,7 +13,7 @@ export default function buildGrpcExporters(config: NodeSDKConfig): Exporters {
       url: `${config.collectorUrl}`,
       compression: CompressionAlgorithm.GZIP,
     }),
-    metrics: new PeriodicExportingMetricReader({
+    metrics: new metrics.PeriodicExportingMetricReader({
       exporter: new OTLPMetricExporter({
         url: `${config.collectorUrl}`,
         compression: CompressionAlgorithm.GZIP,

package/lib/http.ts

@@ -1,11 +1,11 @@
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import type { NodeSDKConfig } from "./index.js";
 import type { Exporters } from "./options.js";
 import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
 import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
 
 export default function buildHttpExporters(config: NodeSDKConfig): Exporters {
   if (config.collectorUrl.endsWith("/")) {
@@ -17,7 +17,7 @@ export default function buildHttpExporters(config: NodeSDKConfig): Exporters {
       url: `${config.collectorUrl}/v1/traces`,
       compression: CompressionAlgorithm.GZIP,
     }),
-    metrics: new PeriodicExportingMetricReader({
+    metrics: new metrics.PeriodicExportingMetricReader({
       exporter: new OTLPMetricExporter({
         url: `${config.collectorUrl}/v1/metrics`,
         compression: CompressionAlgorithm.GZIP,

package/lib/index.ts

@@ -36,7 +36,7 @@ export interface NodeSDKConfig extends SDKConfig {
   enableFS?: boolean;
 
   /**
-   * http based connection protocol used to send signals.
+   * protocol used to send signals.
    *
    * @default grpc
    */
@@ -45,7 +45,7 @@ export interface NodeSDKConfig extends SDKConfig {
 
 export type SDKCollectorMode = "single" | "batch";
 
-export type SDKProtocol = "grpc" | "http";
+export type SDKProtocol = "grpc" | "http" | "console";
 
 export type SDKLogLevel =
   | "NONE"