nestjs-otel 6.0.0 → 6.1.1

package/README.md

@@ -133,6 +133,7 @@ const OpenTelemetryModuleConfig = OpenTelemetryModule.forRoot({
       },
       ignoreRoutes: ['/favicon.ico'], // You can ignore specific routes (See https://docs.nestjs.com/middleware#excluding-routes for options)
       ignoreUndefinedRoutes: false, //Records metrics for all URLs, even undefined ones
+      prefix: 'my_prefix', // Add a custom prefix to all API metrics
     },
   },
 });

package/lib/interfaces/metric-options.interface.d.ts

@@ -0,0 +1,7 @@
+import { MetricOptions } from '@opentelemetry/api';
+export interface OtelMetricOptions extends MetricOptions {
+    /**
+     * A prefix to add to the name of the metric.
+     */
+    prefix?: string;
+}

package/lib/interfaces/metric-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/opentelemetry-options.interface.d.ts

@@ -44,5 +44,6 @@ export type OpenTelemetryMetrics = {
         defaultAttributes?: Attributes;
         ignoreRoutes?: (string | RouteInfo)[];
         ignoreUndefinedRoutes?: boolean;
+        prefix?: string;
     };
 };

package/lib/metrics/decorators/common.d.ts

@@ -1,13 +1,13 @@
-import { MetricOptions } from '@opentelemetry/api';
+import { OtelMetricOptions } from '../../interfaces/metric-options.interface';
 /**
  * Create and increment a counter when a new instance is created
  *
  * @param originalClass
  */
-export declare const OtelInstanceCounter: (options?: MetricOptions) => <T extends new (...args: any[]) => {}>(originalClass: T) => {
+export declare const OtelInstanceCounter: (options?: OtelMetricOptions) => <T extends new (...args: any[]) => {}>(originalClass: T) => {
     new (...args: any[]): {};
 } & T;
 /**
  * Create and increment a counter when the method is called
  */
-export declare const OtelMethodCounter: (options?: MetricOptions) => (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<(...args: any[]) => any>) => void;
+export declare const OtelMethodCounter: (options?: OtelMetricOptions) => (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<(...args: any[]) => any>) => void;

package/lib/metrics/decorators/index.d.ts

@@ -1,4 +1,2 @@
 export * from './common';
-export * from './counter';
-export * from './histogram';
-export * from './observable';
+export * from './param';

package/lib/metrics/decorators/index.js

@@ -2,6 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./common"), exports);
-tslib_1.__exportStar(require("./counter"), exports);
-tslib_1.__exportStar(require("./histogram"), exports);
-tslib_1.__exportStar(require("./observable"), exports);
+tslib_1.__exportStar(require("./param"), exports);

package/lib/metrics/decorators/param.d.ts

@@ -0,0 +1,8 @@
+import { OtelMetricOptions } from '../../interfaces/metric-options.interface';
+export type MetricParamDecorator = (name: string, options?: OtelMetricOptions) => ParameterDecorator;
+export declare const OtelCounter: MetricParamDecorator;
+export declare const OtelUpDownCounter: MetricParamDecorator;
+export declare const OtelHistogram: MetricParamDecorator;
+export declare const OtelObservableGauge: MetricParamDecorator;
+export declare const OtelObservableCounter: MetricParamDecorator;
+export declare const OtelObservableUpDownCounter: MetricParamDecorator;

package/lib/metrics/decorators/param.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OtelObservableUpDownCounter = exports.OtelObservableCounter = exports.OtelObservableGauge = exports.OtelHistogram = exports.OtelUpDownCounter = exports.OtelCounter = void 0;
+const common_1 = require("@nestjs/common");
+const metric_data_1 = require("../metric-data");
+function createMetricParamDecorator(type, getOrCreateMetric) {
+    return (name, options) => {
+        return (0, common_1.createParamDecorator)(() => {
+            if (!name || name.length === 0) {
+                throw new Error(`${type} need a name argument`);
+            }
+            return getOrCreateMetric(name, options);
+        })();
+    };
+}
+exports.OtelCounter = createMetricParamDecorator('OtelCounter', metric_data_1.getOrCreateCounter);
+exports.OtelUpDownCounter = createMetricParamDecorator('OtelUpDownCounter', metric_data_1.getOrCreateCounter);
+exports.OtelHistogram = createMetricParamDecorator('OtelHistogram', metric_data_1.getOrCreateHistogram);
+exports.OtelObservableGauge = createMetricParamDecorator('OtelObservableGauge', metric_data_1.getOrCreateObservableGauge);
+exports.OtelObservableCounter = createMetricParamDecorator('OtelObservableCounter', metric_data_1.getOrCreateObservableCounter);
+exports.OtelObservableUpDownCounter = createMetricParamDecorator('OtelObservableUpDownCounter', metric_data_1.getOrCreateObservableUpDownCounter);

package/lib/metrics/metric-data.d.ts

@@ -1,4 +1,5 @@
-import { Counter, MetricOptions, UpDownCounter, Histogram, ObservableGauge, ObservableCounter, ObservableUpDownCounter } from '@opentelemetry/api';
+import { Counter, UpDownCounter, Histogram, ObservableGauge, ObservableCounter, ObservableUpDownCounter } from '@opentelemetry/api';
+import { OtelMetricOptions } from '../interfaces/metric-options.interface';
 export type GenericMetric = Counter | UpDownCounter | Histogram | ObservableGauge | ObservableCounter | ObservableUpDownCounter;
 export declare enum MetricType {
     'Counter' = "Counter",
@@ -9,9 +10,9 @@ export declare enum MetricType {
     'ObservableUpDownCounter' = "ObservableUpDownCounter"
 }
 export declare const meterData: Map<string, GenericMetric>;
-export declare function getOrCreateHistogram(name: string, options?: MetricOptions): Histogram;
-export declare function getOrCreateCounter(name: string, options?: MetricOptions): Counter;
-export declare function getOrCreateUpDownCounter(name: string, options?: MetricOptions): UpDownCounter;
-export declare function getOrCreateObservableGauge(name: string, options?: MetricOptions): ObservableGauge;
-export declare function getOrCreateObservableCounter(name: string, options?: MetricOptions): ObservableCounter;
-export declare function getOrCreateObservableUpDownCounter(name: string, options?: MetricOptions): ObservableUpDownCounter;
+export declare function getOrCreateHistogram(name: string, options?: OtelMetricOptions): Histogram;
+export declare function getOrCreateCounter(name: string, options?: OtelMetricOptions): Counter;
+export declare function getOrCreateUpDownCounter(name: string, options?: OtelMetricOptions): UpDownCounter;
+export declare function getOrCreateObservableGauge(name: string, options?: OtelMetricOptions): ObservableGauge;
+export declare function getOrCreateObservableCounter(name: string, options?: OtelMetricOptions): ObservableCounter;
+export declare function getOrCreateObservableUpDownCounter(name: string, options?: OtelMetricOptions): ObservableUpDownCounter;

package/lib/metrics/metric-data.js

@@ -13,63 +13,37 @@ var MetricType;
     MetricType["ObservableUpDownCounter"] = "ObservableUpDownCounter";
 })(MetricType || (exports.MetricType = MetricType = {}));
 exports.meterData = new Map();
-function getOrCreateHistogram(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
+function getOrCreate(name, options = {}, type) {
+    const nameWithPrefix = options.prefix ? `${options.prefix}.${name}` : name;
+    let metric = exports.meterData.get(nameWithPrefix);
+    if (metric === undefined) {
+        const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
+        metric = meter[`create${type}`](nameWithPrefix, options);
+        exports.meterData.set(nameWithPrefix, metric);
     }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const histogram = meter.createHistogram(name, options);
-    exports.meterData.set(name, histogram);
-    return histogram;
+    return metric;
+}
+function getOrCreateHistogram(name, options = {}) {
+    return getOrCreate(name, options, MetricType.Histogram);
 }
 exports.getOrCreateHistogram = getOrCreateHistogram;
 function getOrCreateCounter(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
-    }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const counter = meter.createCounter(name, options);
-    exports.meterData.set(name, counter);
-    return counter;
+    return getOrCreate(name, options, MetricType.Counter);
 }
 exports.getOrCreateCounter = getOrCreateCounter;
 function getOrCreateUpDownCounter(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
-    }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const upDownCounter = meter.createUpDownCounter(name, options);
-    exports.meterData.set(name, upDownCounter);
-    return upDownCounter;
+    return getOrCreate(name, options, MetricType.UpDownCounter);
 }
 exports.getOrCreateUpDownCounter = getOrCreateUpDownCounter;
 function getOrCreateObservableGauge(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
-    }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const observableGauge = meter.createObservableGauge(name, options);
-    exports.meterData.set(name, observableGauge);
-    return observableGauge;
+    return getOrCreate(name, options, MetricType.ObservableGauge);
 }
 exports.getOrCreateObservableGauge = getOrCreateObservableGauge;
 function getOrCreateObservableCounter(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
-    }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const observableCounter = meter.createObservableCounter(name, options);
-    exports.meterData.set(name, observableCounter);
-    return observableCounter;
+    return getOrCreate(name, options, MetricType.ObservableCounter);
 }
 exports.getOrCreateObservableCounter = getOrCreateObservableCounter;
 function getOrCreateObservableUpDownCounter(name, options = {}) {
-    if (exports.meterData.has(name)) {
-        return exports.meterData.get(name);
-    }
-    const meter = api_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    const observableCounter = meter.createObservableCounter(name, options);
-    exports.meterData.set(name, observableCounter);
-    return observableCounter;
+    return getOrCreate(name, options, MetricType.ObservableUpDownCounter);
 }
 exports.getOrCreateObservableUpDownCounter = getOrCreateObservableUpDownCounter;

package/lib/metrics/metric.service.d.ts

@@ -1,9 +1,9 @@
-import { MetricOptions } from '@opentelemetry/api';
+import { OtelMetricOptions } from '../interfaces/metric-options.interface';
 export declare class MetricService {
-    getCounter(name: string, options?: MetricOptions): import("@opentelemetry/api").Counter<import("@opentelemetry/api").Attributes>;
-    getUpDownCounter(name: string, options?: MetricOptions): import("@opentelemetry/api").UpDownCounter<import("@opentelemetry/api").Attributes>;
-    getHistogram(name: string, options?: MetricOptions): import("@opentelemetry/api").Histogram<import("@opentelemetry/api").Attributes>;
-    getObservableCounter(name: string, options?: MetricOptions): import("@opentelemetry/api").ObservableCounter;
-    getObservableGauge(name: string, options?: MetricOptions): import("@opentelemetry/api").ObservableGauge;
-    getObservableUpDownCounter(name: string, options?: MetricOptions): import("@opentelemetry/api").ObservableUpDownCounter;
+    getCounter(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").Counter<import("@opentelemetry/api").Attributes>;
+    getUpDownCounter(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").UpDownCounter<import("@opentelemetry/api").Attributes>;
+    getHistogram(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").Histogram<import("@opentelemetry/api").Attributes>;
+    getObservableCounter(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").ObservableCounter;
+    getObservableGauge(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").ObservableGauge;
+    getObservableUpDownCounter(name: string, options?: OtelMetricOptions): import("@opentelemetry/api").ObservableUpDownCounter;
 }

package/lib/middleware/api-metrics.middleware.js

@@ -11,44 +11,53 @@ let ApiMetricsMiddleware = class ApiMetricsMiddleware {
     constructor(metricService, options = {}) {
         this.metricService = metricService;
         this.options = options;
-        const { defaultAttributes = {}, ignoreUndefinedRoutes = false } = options?.metrics?.apiMetrics ?? {};
+        const { defaultAttributes = {}, ignoreUndefinedRoutes = false, prefix, } = options?.metrics?.apiMetrics ?? {};
         this.defaultAttributes = defaultAttributes;
         this.ignoreUndefinedRoutes = ignoreUndefinedRoutes;
         // Semantic Convention
         this.httpServerRequestCount = this.metricService.getCounter('http.server.request.count', {
             description: 'Total number of HTTP requests',
             unit: 'requests',
+            prefix,
         });
         this.httpServerResponseCount = this.metricService.getCounter('http.server.response.count', {
             description: 'Total number of HTTP responses',
             unit: 'responses',
+            prefix,
         });
         this.httpServerAbortCount = this.metricService.getCounter('http.server.abort.count', {
             description: 'Total number of data transfers aborted',
             unit: 'requests',
+            prefix,
         });
         this.httpServerDuration = this.metricService.getHistogram('http.server.duration', {
             description: 'The duration of the inbound HTTP request',
             unit: 'ms',
+            prefix,
         });
         this.httpServerRequestSize = this.metricService.getHistogram('http.server.request.size', {
             description: 'Size of incoming bytes',
             unit: 'By',
+            prefix,
         });
         this.httpServerResponseSize = this.metricService.getHistogram('http.server.response.size', {
             description: 'Size of outgoing bytes',
             unit: 'By',
+            prefix,
         });
         // Helpers
         this.httpServerResponseSuccessCount = this.metricService.getCounter('http.server.response.success.count', {
             description: 'Total number of all successful responses',
             unit: 'responses',
+            prefix,
         });
         this.httpServerResponseErrorCount = this.metricService.getCounter('http.server.response.error.count', {
             description: 'Total number of all response errors',
+            prefix,
         });
         this.httpClientRequestErrorCount = this.metricService.getCounter('http.client.request.error.count', {
             description: 'Total number of client error requests',
+            prefix,
         });
     }
     use(req, res, next) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-otel",
-  "version": "6.0.0",
+  "version": "6.1.1",
   "description": "NestJS OpenTelemetry Library",
   "main": "lib/index.js",
   "typings": "lib/index",

package/lib/metrics/decorators/counter.d.ts

@@ -1,2 +0,0 @@
-export declare const OtelCounter: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
-export declare const OtelUpDownCounter: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;

package/lib/metrics/decorators/counter.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OtelUpDownCounter = exports.OtelCounter = void 0;
-const common_1 = require("@nestjs/common");
-const metric_data_1 = require("../metric-data");
-exports.OtelCounter = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelCounter need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateCounter)(name, options);
-});
-exports.OtelUpDownCounter = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelUpDownCounter need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateCounter)(name, options);
-});

package/lib/metrics/decorators/histogram.d.ts

@@ -1 +0,0 @@
-export declare const OtelHistogram: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;

package/lib/metrics/decorators/histogram.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OtelHistogram = void 0;
-const common_1 = require("@nestjs/common");
-const metric_data_1 = require("../metric-data");
-exports.OtelHistogram = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelHistogram need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateHistogram)(name, options);
-});

package/lib/metrics/decorators/observable.d.ts

@@ -1,3 +0,0 @@
-export declare const OtelObservableGauge: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
-export declare const OtelObservableCounter: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
-export declare const OtelObservableUpDownCounter: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;

package/lib/metrics/decorators/observable.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OtelObservableUpDownCounter = exports.OtelObservableCounter = exports.OtelObservableGauge = void 0;
-const common_1 = require("@nestjs/common");
-const metric_data_1 = require("../metric-data");
-exports.OtelObservableGauge = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelObservableGauge need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateObservableGauge)(name, options);
-});
-exports.OtelObservableCounter = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelObservableCounter need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateObservableCounter)(name, options);
-});
-exports.OtelObservableUpDownCounter = (0, common_1.createParamDecorator)((name, options) => {
-    if (!name || name.length === 0) {
-        throw new Error('OtelObservableUpDownCounter need a name argument');
-    }
-    return (0, metric_data_1.getOrCreateObservableUpDownCounter)(name, options);
-});