nestjs-otel 7.0.1 → 8.0.0

package/README.md

@@ -119,16 +119,6 @@ bootstrap();
 const OpenTelemetryModuleConfig = OpenTelemetryModule.forRoot({
   metrics: {
     hostMetrics: true, // Includes Host Metrics
-    apiMetrics: { // @deprecated - will be removed in 8.0 - you should start using the semcov from opentelemetry metrics instead
-      enable: true, // Includes api metrics
-      defaultAttributes: {
-        // You can set default labels for api metrics
-        custom: 'label',
-      },
-      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
-    },
   },
 });
 
@@ -158,14 +148,11 @@ export class OtelConfigService implements OpenTelemetryOptionsFactory {
   constructor(private configService: ConfigService) {}
 
   createOpenTelemetryOptions(): Promise<OpenTelemetryModuleOptions> | OpenTelemetryModuleOptions {
-    const { hostMetrics, apiMetrics } = this.configService.get('otel')
+    const { hostMetrics } = this.configService.get('otel')
 
     return {
       metrics: {
         hostMetrics: hostMetrics.enabled,
-        apiMetrics: {
-          enable: apiMetrics.enabled,
-        },
       },
     };
   }
@@ -217,8 +204,80 @@ export class BooksService {
   async getBookOnceMore(id: number) {
     // ...
   }
+
+  // Capture return value as attribute
+  // Note: Explicitly type the result to ensure type safety
+  @Span({
+    onResult: (result: string[]) => ({ attributes: { 'book.count': result.length } }),
+  })
+  async getBooks() {
+    return ['Book 1', 'Book 2'];
+  }
+}
+
+```
+
+## Traceable Decorator
+
+If you want to trace all methods in a class, you can use the `@Traceable` decorator.
+
+```ts
+import { Traceable } from 'nestjs-otel';
+
+@Injectable()
+@Traceable()
+export class UsersService {
+  findAll() {
+    // This method will be automatically traced
+    return [];
+  }
+
+  findOne(id: string) {
+    // This method will also be automatically traced
+    return {};
+  }
+}
+```
+
+## Current Span Decorator
+
+You can access the current span in your controllers using the `@CurrentSpan` decorator.
+
+> **Note:** This decorator only works in Controllers, Resolvers, and Gateways where NestJS handles argument injection. It does **not** work in standard service-to-service calls.
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { Span } from '@opentelemetry/api';
+import { CurrentSpan } from 'nestjs-otel';
+
+@Controller('cats')
+export class CatsController {
+  @Get()
+  findAll(@CurrentSpan() span: Span) {
+    if (span) {
+      span.setAttribute('custom.attribute', 'value');
+    }
+    return 'This action returns all cats';
+  }
 }
+```
+
+## Baggage Decorator
+
+You can access the OpenTelemetry Baggage (Distributed Context) in your controllers using the `@Baggage` decorator.
+
+```ts
+import { Controller, Get } from '@nestjs/common';
+import { Baggage } from 'nestjs-otel';
 
+@Controller('cats')
+export class CatsController {
+  @Get()
+  findAll(@Baggage('tenant-id') tenantId: string) {
+    console.log('Tenant ID:', tenantId);
+    return 'This action returns all cats';
+  }
+}
 ```
 
 ## Tracing Service
@@ -333,22 +392,6 @@ export class AppController {
 }
 ```
 
-## API Metrics with Middleware
-
-> @deprecated - this will be removed in 8.0 - you should start using the semcov from opentelemetry metrics instead
-
-| Impl | Otel Metric                         | Prometheus Metric                         | Description                               | Metric Type |
-| ---- | --------------------------------    | ---------------------------------------   | ----------------------------------------- | ----------- |
-| ✅   | http.server.request.count           | http_server_request_count_total           | Total number of HTTP requests.            | Counter     |
-| ✅   | http.server.response.count          | http_server_response_count_total          | Total number of HTTP responses.           | Counter     |
-| ✅   | http.server.abort.count             | http_server_abort_count_total             | Total number of data transfers aborted.   | Counter     |
-| ✅   | http.server.duration                | http_server_duration                      | The duration of the inbound HTTP request. | Histogram   |
-| ✅   | http.server.request.size            | http_server_request_size                  | Size of incoming bytes.                   | Histogram   |
-| ✅   | http.server.response.size           | http_server_response_size                 | Size of outgoing bytes.                   | Histogram   |
-| ✅   | http.server.response.success.count  | http_server_response_success_count_total  | Total number of all successful responses. | Counter     |
-| ✅   | http.server.response.error.count    | http_server_response_error_count_total    | Total number of server error responses.   | Counter     |
-| ✅   | http.client.request.error.count     | http_client_request_error_count_total     | Total number of client error requests.    | Counter     |
-
 ## Prometheus Metrics
 
 When `metricExporter` is defined in otel SDK with a `PrometheusExporter`it will start a new process on port `8081` (default port) and metrics will be available at `http://localhost:8081/metrics`.

package/UPGRADING.md

@@ -0,0 +1,75 @@
+# Upgrading from v7 to v8
+
+This guide provides instructions for upgrading `nestjs-otel` from version 7.x to version 8.x.
+
+## Breaking Changes
+
+### Metric Naming Convention
+
+The default naming convention for metrics generated by decorators has changed to follow OpenTelemetry standards (using dots `.` instead of underscores `_` as separators).
+
+**Previous Behavior (v7):**
+- Instance Counter: `app_ClassName_instances_total`
+- Method Counter: `app_ClassName_methodName_calls_total`
+
+**New Behavior (v8):**
+- Instance Counter: `app.ClassName.instances.total`
+- Method Counter: `app.ClassName.methodName.calls.total`
+
+**Action Required:**
+If you are using default metric names in your dashboards (e.g., Grafana) or alerts, you will need to update the metric names to match the new dot-notation format.
+
+If you were manually specifying names in the decorators (e.g., `@OtelMethodCounter({ name: 'my_custom_name' })`), no change is required as your custom names are preserved.
+
+### Deprecated API Middleware and Configuration Removed
+
+The deprecated API middleware and its associated configuration have been removed.
+
+- The `apiMetrics` option in `OpenTelemetryModuleOptions` is no longer available.
+- The `ApiMetricsMiddleware` class has been removed.
+
+If you were relying on this middleware for request tracing, please ensure you are using the OpenTelemetry SDK's auto-instrumentation or the provided decorators.
+
+## New Features
+
+### New Decorators
+
+v8 introduces several new decorators to improve the developer experience:
+
+- **`@Traceable()`**: A class-level decorator that automatically applies tracing to all methods in a class.
+  ```typescript
+  @Traceable()
+  @Injectable()
+  export class MyService {
+    // All methods are now traced automatically
+  }
+  ```
+
+- **`@CurrentSpan()`**: A parameter decorator to inject the current OpenTelemetry Span into your controller methods.
+  ```typescript
+  @Get()
+  findAll(@CurrentSpan() span: Span) {
+    span.setAttribute('custom.attr', 'value');
+  }
+  ```
+
+- **`@Baggage(key)`**: A parameter decorator to extract OpenTelemetry Baggage values.
+  ```typescript
+  @Get()
+  findAll(@Baggage('tenant-id') tenantId: string) {
+    // ...
+  }
+  ```
+
+### Span Decorator Enhancements
+
+The `@Span` decorator now supports capturing the return value of a method using the `onResult` callback.
+
+```typescript
+@Span({
+  onResult: (result) => ({ attributes: { 'item.count': result.length } }),
+})
+async getItems() {
+  return [1, 2, 3];
+}
+```

package/biome.jsonc

@@ -0,0 +1,40 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "extends": ["ultracite/core"],
+  "javascript": {
+    "parser": {
+      "unsafeParameterDecoratorsEnabled": true
+    },
+    "globals": ["jest"]
+  },
+  "linter": {
+    "rules": {
+      "performance": {
+        "noBarrelFile": "off",
+        "useTopLevelRegex": "off",
+        "noNamespaceImport": "off"
+      },
+      "suspicious": {
+        "noExplicitAny": "off",
+        "useAwait": "off",
+        "noEmptyBlockStatements": "off",
+        "noImplicitAnyLet": "off",
+        "noEvolvingTypes": "off",
+        "noSkippedTests": "off"
+      },
+      "style": {
+        "useConsistentMemberAccessibility": "off",
+        "noDoneCallback": "off",
+        "noParameterProperties": "off",
+        "noEnum": "off"
+      },
+      "complexity": {
+        "noStaticOnlyClass": "off",
+        "noBannedTypes": "off"
+      },
+      "nursery": {
+        "noShadow": "off"
+      }
+    }
+  }
+}

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "nestjs-otel",
-  "version": "7.0.1",
+  "version": "8.0.0",
   "description": "NestJS OpenTelemetry Library",
   "main": "lib/index.js",
   "typings": "lib/index",
   "engines": {
-    "node": ">= 20"
+    "node": ">= 22"
   },
   "scripts": {
     "prebuild": "rimraf lib",
     "build": "tsc",
-    "lint": "prettier --check ./**/*.{js,json,ts}",
-    "format": "prettier --write ./**/*.{js,json,ts}",
+    "lint": "ultracite check",
+    "format": "ultracite fix",
     "test": "npm run test:unit && npm run test:e2e",
     "test:coverage": "jest --coverage",
     "test:unit": "jest",
     "test:watch": "jest --watch",
-    "test:e2e": "jest --config ./tests/jest-e2e.json --runInBand --forceExit",
+    "test:e2e": "jest --config ./tests/jest-e2e.json --runInBand --forceExit --detectOpenHandles",
     "test:e2e:watch": "jest --config ./tests/jest-e2e.json --runInBand --watch",
     "prepare": "husky"
   },
@@ -39,34 +39,34 @@
   "homepage": "https://github.com/pragmaticivan/nestjs-otel#readme",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/host-metrics": "^0.36.0",
-    "response-time": "^2.3.3"
+    "@opentelemetry/host-metrics": "^0.37.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@nestjs/common": "^11.1.1",
-    "@nestjs/core": "^11.1.1",
-    "@nestjs/platform-express": "^11.1.1",
-    "@nestjs/platform-fastify": "^11.1.1",
-    "@nestjs/testing": "^11.1.1",
-    "@opentelemetry/exporter-prometheus": "^0.203.0",
-    "@opentelemetry/sdk-metrics": "^2.0.0",
-    "@opentelemetry/sdk-trace-node": "^2.0.0",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.15.18",
-    "@types/response-time": "^2.3.8",
+    "@biomejs/biome": "^2.3.8",
+    "@commitlint/cli": "^20.2.0",
+    "@commitlint/config-conventional": "^20.2.0",
+    "@nestjs/common": "^11.1.9",
+    "@nestjs/core": "^11.1.9",
+    "@nestjs/platform-express": "^11.1.9",
+    "@nestjs/platform-fastify": "^11.1.9",
+    "@nestjs/testing": "^11.1.9",
+    "@opentelemetry/exporter-prometheus": "^0.208.0",
+    "@opentelemetry/sdk-metrics": "^2.2.0",
+    "@opentelemetry/sdk-trace-node": "^2.2.0",
+    "@types/express": "^5.0.6",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.1",
     "@types/supertest": "^6.0.3",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "lint-staged": "^16.0.0",
-    "prettier": "^3.5.3",
+    "jest": "^30.2.0",
+    "lint-staged": "^16.2.7",
     "reflect-metadata": "^0.2.2",
-    "rimraf": "^6.0.1",
+    "rimraf": "^6.1.2",
     "rxjs": "^7.8.2",
-    "supertest": "^7.1.1",
-    "ts-jest": "^29.3.3",
-    "typescript": "5.8.3"
+    "supertest": "^7.1.4",
+    "ts-jest": "^29.4.6",
+    "typescript": "5.9.3",
+    "ultracite": "^6.3.10"
   },
   "peerDependencies": {
     "@nestjs/common": ">= 11 < 12",
@@ -91,8 +91,8 @@
     "testEnvironment": "node"
   },
   "lint-staged": {
-    "**/*.{js,ts,json}": [
-      "prettier --write"
+    "*.{js,jsx,ts,tsx,json,jsonc,css,scss,md,mdx}": [
+      "npx ultracite fix"
     ]
   }
 }

package/lib/feature-detection.utils.d.ts

@@ -1,5 +0,0 @@
-export declare enum HttpAdapterType {
-    EXPRESS = "express",
-    FASTIFY = "fastify"
-}
-export declare function detectHttpAdapterType(httpAdapter: any): HttpAdapterType;

package/lib/feature-detection.utils.js

@@ -1,16 +0,0 @@
-"use strict";
-// Kudos to Papooch - https://github.com/Papooch/nestjs-cls/blob/2803ce67409c493601cc61a3299e7b47d3869c66/packages/core/src/lib/cls-module/feature-detection.utils.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpAdapterType = void 0;
-exports.detectHttpAdapterType = detectHttpAdapterType;
-var HttpAdapterType;
-(function (HttpAdapterType) {
-    HttpAdapterType["EXPRESS"] = "express";
-    HttpAdapterType["FASTIFY"] = "fastify";
-})(HttpAdapterType || (exports.HttpAdapterType = HttpAdapterType = {}));
-function detectHttpAdapterType(httpAdapter) {
-    if (httpAdapter.constructor.name === 'FastifyAdapter') {
-        return HttpAdapterType.FASTIFY;
-    }
-    return HttpAdapterType.EXPRESS;
-}

package/lib/feature-detection.utils.spec.d.ts

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

package/lib/feature-detection.utils.spec.js

@@ -1,85 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const feature_detection_utils_1 = require("./feature-detection.utils");
-describe('FeatureDetectionUtils', () => {
-    describe('When using Express adapter', () => {
-        async function getExpressApp() {
-            const { Module } = await Promise.resolve().then(() => __importStar(require('@nestjs/common')));
-            const { Test } = await Promise.resolve().then(() => __importStar(require('@nestjs/testing')));
-            let TestModule = class TestModule {
-            };
-            TestModule = __decorate([
-                Module({})
-            ], TestModule);
-            const module = await Test.createTestingModule({
-                imports: [TestModule],
-            }).compile();
-            return module.createNestApplication();
-        }
-        it('should detect Express version 5 on Nest 11', async () => {
-            const app = await getExpressApp();
-            const adapterType = (0, feature_detection_utils_1.detectHttpAdapterType)(app.getHttpAdapter());
-            expect(adapterType).toEqual(feature_detection_utils_1.HttpAdapterType.EXPRESS);
-        });
-    });
-    describe('When using Fastify adapter', () => {
-        async function getFastifyApp() {
-            const { Module } = await Promise.resolve().then(() => __importStar(require('@nestjs/common')));
-            const { Test } = await Promise.resolve().then(() => __importStar(require('@nestjs/testing')));
-            const { FastifyAdapter } = await Promise.resolve().then(() => __importStar(require('@nestjs/platform-fastify')));
-            let TestModule = class TestModule {
-            };
-            TestModule = __decorate([
-                Module({})
-            ], TestModule);
-            const module = await Test.createTestingModule({
-                imports: [TestModule],
-            }).compile();
-            return module.createNestApplication(new FastifyAdapter());
-        }
-        it('should detect Fastify version 5 on Nest 11', async () => {
-            const app = await getFastifyApp();
-            const adapterType = (0, feature_detection_utils_1.detectHttpAdapterType)(app.getHttpAdapter());
-            expect(adapterType).toEqual(feature_detection_utils_1.HttpAdapterType.FASTIFY);
-        });
-    });
-});

package/lib/index.d.ts

@@ -1,8 +0,0 @@
-export * from './opentelemetry.module';
-export * from './tracing/decorators/span';
-export * from './tracing/trace.service';
-export * from './metrics/metric.service';
-export * from './metrics/injector';
-export * from './metrics/decorators';
-export * from './opentelemetry.constants';
-export * from './interfaces';

package/lib/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./opentelemetry.module"), exports);
-__exportStar(require("./tracing/decorators/span"), exports);
-__exportStar(require("./tracing/trace.service"), exports);
-__exportStar(require("./metrics/metric.service"), exports);
-__exportStar(require("./metrics/injector"), exports);
-__exportStar(require("./metrics/decorators"), exports);
-__exportStar(require("./opentelemetry.constants"), exports);
-__exportStar(require("./interfaces"), exports);

package/lib/interfaces/index.d.ts

@@ -1,2 +0,0 @@
-export * from './opentelemetry-options.interface';
-export * from './metric-options.interface';

package/lib/interfaces/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./opentelemetry-options.interface"), exports);
-__exportStar(require("./metric-options.interface"), exports);

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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1,52 +0,0 @@
-import { ModuleMetadata, Type, Abstract } from '@nestjs/common';
-import { Attributes } from '@opentelemetry/api';
-import { RouteInfo } from '@nestjs/common/interfaces';
-export type OpenTelemetryModuleOptions = {
-    /**
-     * OpenTelemetry Metrics Setup
-     */
-    metrics?: OpenTelemetryMetrics;
-};
-export interface OpenTelemetryOptionsFactory {
-    createOpenTelemetryOptions(): Promise<OpenTelemetryModuleOptions> | OpenTelemetryModuleOptions;
-}
-/**
- * The options for the asynchronous Terminus module creation
- *
- * @publicApi
- */
-export interface OpenTelemetryModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    /**
-     * The name of the module
-     */
-    name?: string;
-    /**
-     * The class which should be used to provide the Terminus options
-     */
-    useClass?: Type<OpenTelemetryOptionsFactory>;
-    /**
-     * Import existing providers from other module
-     */
-    useExisting?: Type<OpenTelemetryOptionsFactory>;
-    /**
-     * The factory which should be used to provide the Terminus options
-     */
-    useFactory?: (...args: any[]) => Promise<OpenTelemetryModuleOptions> | OpenTelemetryModuleOptions;
-    /**
-     * The providers which should get injected
-     */
-    inject?: (string | symbol | Function | Type<any> | Abstract<any>)[];
-}
-export type OpenTelemetryMetrics = {
-    hostMetrics?: boolean;
-    /**
-     * @deprecated apiMetrics is deprecated. Use semcov from opentelemetry metrics instead.
-     */
-    apiMetrics?: {
-        enable?: boolean;
-        defaultAttributes?: Attributes;
-        ignoreRoutes?: (string | RouteInfo)[];
-        ignoreUndefinedRoutes?: boolean;
-        prefix?: string;
-    };
-};

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

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

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

@@ -1,15 +0,0 @@
-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?: 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?: OtelMetricOptions) => (target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<(...args: any[]) => any>) => void;

package/lib/metrics/decorators/common.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OtelMethodCounter = exports.OtelInstanceCounter = void 0;
-const opentelemetry_utils_1 = require("../../opentelemetry.utils");
-const metric_data_1 = require("../metric-data");
-/**
- * Create and increment a counter when a new instance is created
- *
- * @param originalClass
- */
-const OtelInstanceCounter = (options) => (originalClass) => {
-    const name = `app_${originalClass.name}_instances_total`;
-    const description = `app_${originalClass.name} object instances total`;
-    let counterMetric;
-    const wrappedClass = class extends originalClass {
-        constructor(...args) {
-            if (!counterMetric) {
-                counterMetric = (0, metric_data_1.getOrCreateCounter)(name, { description, ...options });
-            }
-            counterMetric.add(1);
-            super(...args);
-        }
-    };
-    Object.defineProperty(wrappedClass, 'name', { value: originalClass.name });
-    (0, opentelemetry_utils_1.copyMetadataFromFunctionToFunction)(originalClass, wrappedClass);
-    return wrappedClass;
-};
-exports.OtelInstanceCounter = OtelInstanceCounter;
-/**
- * Create and increment a counter when the method is called
- */
-const OtelMethodCounter = (options) => (target, propertyKey, descriptor) => {
-    const className = target.constructor.name;
-    const name = `app_${className}_${propertyKey.toString()}_calls_total`;
-    const description = `app_${className}#${propertyKey.toString()} called total`;
-    let counterMetric;
-    const originalFunction = descriptor.value ?? (() => { });
-    const wrappedFunction = function PropertyDescriptor(...args) {
-        if (!counterMetric) {
-            counterMetric = (0, metric_data_1.getOrCreateCounter)(name, { description, ...options });
-        }
-        counterMetric.add(1);
-        // @ts-ignore
-        return originalFunction.apply(this, args);
-    };
-    descriptor.value = new Proxy(originalFunction, {
-        apply: (_, thisArg, args) => {
-            return wrappedFunction.apply(thisArg, args);
-        },
-    });
-    (0, opentelemetry_utils_1.copyMetadataFromFunctionToFunction)(originalFunction, descriptor.value);
-};
-exports.OtelMethodCounter = OtelMethodCounter;

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

@@ -1 +0,0 @@
-import 'reflect-metadata';