@ogcio/o11y-sdk-node 0.1.0-beta.7 → 0.1.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.1.0-beta.8](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.1.0-beta.7...@ogcio/o11y-sdk-node@v0.1.0-beta.8) (2025-03-07)
+
+
+### Features
+
+* o11y showcase AB[#25895](https://github.com/ogcio/o11y/issues/25895) ([#84](https://github.com/ogcio/o11y/issues/84)) ([f8f10af](https://github.com/ogcio/o11y/commit/f8f10af97d9f5c188e3e65f7d62d5c673edce25a))
+
+
+### Bug Fixes
+
+* improve getMetric attributes types ([#76](https://github.com/ogcio/o11y/issues/76)) ([243649c](https://github.com/ogcio/o11y/commit/243649c4bfe750687a729fbd836772cce16e0cb1))
+
 ## [0.1.0-beta.7](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.1.0-beta.6...@ogcio/o11y-sdk-node@v0.1.0-beta.7) (2025-02-18)
 
 

package/dist/lib/instrumentation.node.js

@@ -85,8 +85,7 @@ function isUrl(url) {
         new URL(url);
         return true;
     }
-    catch (err) {
-        console.error(err);
+    catch (_) {
         return false;
     }
 }

package/dist/lib/metrics.d.ts

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

package/dist/lib/metrics.js

@@ -8,21 +8,17 @@ const MetricsFactoryMap = {
     "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();
+function getMeter({ meterName }) {
+    if (!meterName) {
+        console.error("Invalid metric name!");
+        return createNoopMeter();
     }
-    else {
-        meter = metrics.getMeter(`custom_metric.${metricName}`);
-    }
-    return meter;
+    return metrics.getMeter(`custom_metric.${meterName}`);
 }
 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);
+    return MetricsFactoryMap[type](meter).bind(meter)(p.metricName, p.options);
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ogcio/o11y-sdk-node",
-    "version": "0.1.0-beta.7",
+    "version": "0.1.0-beta.8",
     "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
     "main": "dist/index.js",
     "type": "module",
@@ -28,7 +28,7 @@
     "license": "ISC",
     "dependencies": {
         "@opentelemetry/api": "^1.9.0",
-        "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+        "@opentelemetry/auto-instrumentations-node": "^0.56.1",
         "@opentelemetry/core": "1.30.1",
         "@opentelemetry/exporter-logs-otlp-grpc": "^0.57.2",
         "@opentelemetry/exporter-logs-otlp-http": "^0.57.2",
@@ -44,10 +44,10 @@
         "@opentelemetry/sdk-trace-base": "^1.30.1"
     },
     "devDependencies": {
-        "@types/node": "^22.13.4",
-        "@vitest/coverage-v8": "^3.0.5",
-        "tsx": "^4.19.2",
-        "typescript": "^5.7.3",
-        "vitest": "^3.0.5"
+        "@types/node": "^22.13.9",
+        "@vitest/coverage-v8": "^3.0.8",
+        "tsx": "^4.19.3",
+        "typescript": "^5.8.2",
+        "vitest": "^3.0.8"
     }
 }

package/lib/instrumentation.node.ts

@@ -126,8 +126,7 @@ function isUrl(url: string): boolean {
   try {
     new URL(url);
     return true;
-  } catch (err) {
-    console.error(err);
+  } catch (_) {
     return false;
   }
 }

package/lib/metrics.ts

@@ -10,26 +10,30 @@ import {
   ObservableGauge,
   ObservableUpDownCounter,
   UpDownCounter,
+  Attributes,
 } 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 MetricTypeMap<TAttributes extends Attributes> = {
+  counter: Counter<TAttributes>;
+  histogram: Histogram<TAttributes>;
+  gauge: Gauge<TAttributes>;
+  updowncounter: UpDownCounter<TAttributes>;
+  "async-counter": ObservableCounter<TAttributes>;
+  "async-updowncounter": ObservableUpDownCounter<TAttributes>;
+  "async-gauge": ObservableGauge<TAttributes>;
 };
 
-type MetricType = keyof typeof MetricsMap;
+export type MetricType = keyof MetricTypeMap<Attributes>;
 
-const MetricsFactoryMap: {
-  [K in MetricType]: (
+const MetricsFactoryMap: Record<
+  MetricType,
+  (
     meter: Meter,
-  ) => (name: string, options?: MetricOptions) => (typeof MetricsMap)[K];
-} = {
+  ) => (
+    name: string,
+    options?: MetricOptions,
+  ) => MetricTypeMap<Attributes>[MetricType]
+> = {
   gauge: (meter: Meter) => meter.createGauge,
   histogram: (meter: Meter) => meter.createHistogram,
   counter: (meter: Meter) => meter.createCounter,
@@ -37,34 +41,35 @@ const MetricsFactoryMap: {
   "async-counter": (meter: Meter) => meter.createObservableCounter,
   "async-updowncounter": (meter: Meter) => meter.createObservableUpDownCounter,
   "async-gauge": (meter: Meter) => meter.createObservableGauge,
-};
+} as const;
 
 export interface MetricsParams {
+  meterName: string;
   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}`);
+function getMeter({ meterName }: MetricsParams) {
+  if (!meterName) {
+    console.error("Invalid metric name!");
+    return createNoopMeter();
   }
-  return meter;
+
+  return metrics.getMeter(`custom_metric.${meterName}`);
 }
 
-export function getMetric<T extends MetricType>(
-  type: T,
-  p: MetricsParams,
-): (typeof MetricsMap)[T] {
+export function getMetric<
+  T extends MetricType,
+  TAttributes extends Attributes = Attributes,
+>(type: T, p: MetricsParams): MetricTypeMap<TAttributes>[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);
+  return MetricsFactoryMap[type](meter).bind(meter)(
+    p.metricName,
+    p.options,
+  ) as MetricTypeMap<TAttributes>[T];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/o11y-sdk-node",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-beta.8",
   "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
   "main": "dist/index.js",
   "type": "module",
@@ -20,7 +20,7 @@
   "license": "ISC",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
     "@opentelemetry/core": "1.30.1",
     "@opentelemetry/exporter-logs-otlp-grpc": "^0.57.2",
     "@opentelemetry/exporter-logs-otlp-http": "^0.57.2",
@@ -36,11 +36,11 @@
     "@opentelemetry/sdk-trace-base": "^1.30.1"
   },
   "devDependencies": {
-    "@types/node": "^22.13.4",
-    "@vitest/coverage-v8": "^3.0.5",
-    "tsx": "^4.19.2",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.5"
+    "@types/node": "^22.13.9",
+    "@vitest/coverage-v8": "^3.0.8",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.8"
   },
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.json",

package/test/integration/run.sh

@@ -37,6 +37,9 @@ if [[ $ERROR_CODE -eq 0 ]]; then
     docker run --detach \
         --network $NETWORK_NAME \
         --name $NODE_CONTAINER_NAME \
+        -e DB_DISABLED="true" \
+        -e SERVER_HOST="0.0.0.0" \
+        -e OTEL_COLLECTOR_URL="http://integrationalloy:4317" \
         --health-cmd="curl -f http://${NODE_CONTAINER_NAME}:9091/api/health > /dev/null || exit 1" \
         --health-start-period=1s \
         --health-retries=10 \

package/test/metrics.test.ts

@@ -29,7 +29,7 @@ describe("MetricsFactoryMap", () => {
 
   const validMetricParams: MetricsParams = {
     metricName: "test-metric",
-    attributeName: "test-attribute",
+    meterName: "test-meter",
     options: { description: "A test metric" },
   };
 
@@ -40,7 +40,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-gauge");
     expect(mockMeter.createGauge).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -52,7 +52,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-histogram");
     expect(mockMeter.createHistogram).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -64,7 +64,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-counter");
     expect(mockMeter.createCounter).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -76,7 +76,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-updowncounter");
     expect(mockMeter.createUpDownCounter).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -88,7 +88,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-async-counter");
     expect(mockMeter.createObservableCounter).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -102,7 +102,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-async-updowncounter");
     expect(mockMeter.createObservableUpDownCounter).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -114,7 +114,7 @@ describe("MetricsFactoryMap", () => {
 
     expect(result).toBe("mocked-async-gauge");
     expect(mockMeter.createObservableGauge).toHaveBeenCalledWith(
-      validMetricParams.attributeName,
+      validMetricParams.metricName,
       validMetricParams.options,
     );
   });
@@ -131,7 +131,7 @@ describe("MetricsFactoryMap", () => {
   test("should return noop metric fallback for null config", async () => {
     const nullMetricParams: MetricsParams = {
       metricName: null!,
-      attributeName: "",
+      meterName: "",
     };
 
     const result = getMetric("async-gauge", nullMetricParams);