nestjs-otel 6.1.0 → 6.1.2

package/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing Guide
+
+We'd love your help!
+
+- [Contributing Guide](#contributing-guide)
+  - [Development Quick Start](#development-quick-start)
+  - [Report a bug or requesting feature](#report-a-bug-or-requesting-feature)
+  - [How to contribute](#how-to-contribute)
+      - [Conventional commit](#conventional-commit)
+    - [Fork](#fork)
+
+## Development Quick Start
+
+To get the project started quickly, you can follow these steps. For more
+detailed instructions, see [development](#development) below.
+
+```sh
+git clone https://github.com/pragmaticivan/nestjs-otel.git
+cd nestjs-otel
+npm ci
+npm run test
+```
+
+## Report a bug or requesting feature
+
+Reporting bugs is an important contribution. Please make sure to include:
+
+- expected and actual behavior.
+- Node version that application is running.
+- OpenTelemetry version that application is using.
+- if possible - repro application and steps to reproduce.
+
+## How to contribute
+
+#### Conventional commit
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [here](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples).
+We use [commitlint](https://github.com/conventional-changelog/commitlint) and [husky](https://github.com/typicode/husky) to prevent bad commit message.
+For example, you want to submit the following commit message `git commit -s -am "my bad commit"`.
+You will receive the following error :
+
+```text
+✖   type must be one of [ci, feat, fix, docs, style, refactor, perf, test, revert, chore] [type-enum]
+```
+
+Here an example that will pass the verification: `git commit -s -am "chore(opentelemetry): update deps"`
+
+### Fork
+
+In the interest of keeping this repository clean and manageable, you should work from a fork. To create a fork, click the 'Fork' button at the top of the repository, then clone the fork locally using `git clone git@github.com:USERNAME/nestjs-otel.git`.
+
+You should also add this repository as an "upstream" repo to your local copy, in order to keep it up to date. You can add this as a remote like so:
+
+```sh
+git remote add upstream https://github.com/pragmaticivan/nestjs-otel.git
+
+#verify that the upstream exists
+git remote -v
+```
+
+To update your fork, fetch the upstream repo's branches and commits, then merge your main with upstream's main:
+
+```sh
+git fetch upstream
+git checkout main
+git merge upstream/main
+```
+
+Remember to always work in a branch of your local copy, as you might otherwise have to contend with conflicts in main.

package/README.md

@@ -1,6 +1,5 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
-</p>
+![nestjs-otel](https://github.com/pragmaticivan/nestjs-otel/assets/301291/40aaad82-82f9-48e5-b204-0e3cef532813)
+
 
 # NestJS OpenTelemetry (OTEL)
 
@@ -186,7 +185,7 @@ export class BookService {
 
 ## Metric Service
 
-[OpenTelemetry Metrics](https://www.npmjs.com/package/@opentelemetry/api-metrics) allow a user to collect data and export it to metrics backend like Prometheus.
+[OpenTelemetry Metrics](https://www.npmjs.com/package/@opentelemetry/api) allow a user to collect data and export it to metrics backend like Prometheus.
 
 ```ts
 import { MetricService } from 'nestjs-otel';

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

@@ -4,7 +4,9 @@ import { OtelMetricOptions } from '../../interfaces/metric-options.interface';
  *
  * @param originalClass
  */
-export declare const OtelInstanceCounter: (options?: OtelMetricOptions) => <T extends new (...args: any[]) => {}>(originalClass: T) => {
+export declare const OtelInstanceCounter: (options?: OtelMetricOptions) => <T extends {
+    new (...args: any[]): {};
+}>(originalClass: T) => {
     new (...args: any[]): {};
 } & T;
 /**

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/injector.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InjectMetric = void 0;
+exports.InjectMetric = InjectMetric;
 const common_1 = require("@nestjs/common");
 const utils_1 = require("./utils");
 function InjectMetric(name) {
     const token = (0, utils_1.getToken)(name);
     return (0, common_1.Inject)(token);
 }
-exports.InjectMetric = InjectMetric;

package/lib/metrics/metric-data.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrCreateObservableUpDownCounter = exports.getOrCreateObservableCounter = exports.getOrCreateObservableGauge = exports.getOrCreateUpDownCounter = exports.getOrCreateCounter = exports.getOrCreateHistogram = exports.meterData = exports.MetricType = void 0;
+exports.meterData = exports.MetricType = void 0;
+exports.getOrCreateHistogram = getOrCreateHistogram;
+exports.getOrCreateCounter = getOrCreateCounter;
+exports.getOrCreateUpDownCounter = getOrCreateUpDownCounter;
+exports.getOrCreateObservableGauge = getOrCreateObservableGauge;
+exports.getOrCreateObservableCounter = getOrCreateObservableCounter;
+exports.getOrCreateObservableUpDownCounter = getOrCreateObservableUpDownCounter;
 const api_1 = require("@opentelemetry/api");
 const opentelemetry_constants_1 = require("../opentelemetry.constants");
 var MetricType;
@@ -26,24 +32,18 @@ function getOrCreate(name, options = {}, type) {
 function getOrCreateHistogram(name, options = {}) {
     return getOrCreate(name, options, MetricType.Histogram);
 }
-exports.getOrCreateHistogram = getOrCreateHistogram;
 function getOrCreateCounter(name, options = {}) {
     return getOrCreate(name, options, MetricType.Counter);
 }
-exports.getOrCreateCounter = getOrCreateCounter;
 function getOrCreateUpDownCounter(name, options = {}) {
     return getOrCreate(name, options, MetricType.UpDownCounter);
 }
-exports.getOrCreateUpDownCounter = getOrCreateUpDownCounter;
 function getOrCreateObservableGauge(name, options = {}) {
     return getOrCreate(name, options, MetricType.ObservableGauge);
 }
-exports.getOrCreateObservableGauge = getOrCreateObservableGauge;
 function getOrCreateObservableCounter(name, options = {}) {
     return getOrCreate(name, options, MetricType.ObservableCounter);
 }
-exports.getOrCreateObservableCounter = getOrCreateObservableCounter;
 function getOrCreateObservableUpDownCounter(name, options = {}) {
     return getOrCreate(name, options, MetricType.ObservableUpDownCounter);
 }
-exports.getOrCreateObservableUpDownCounter = getOrCreateObservableUpDownCounter;

package/lib/metrics/utils.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getToken = void 0;
+exports.getToken = getToken;
 /**
  * @public
  */
 function getToken(name) {
     return `OTEL_METRIC_${name.toUpperCase()}`;
 }
-exports.getToken = getToken;

package/lib/tracing/decorators/span.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Span = void 0;
+exports.Span = Span;
 const api_1 = require("@opentelemetry/api");
 const opentelemetry_utils_1 = require("../../opentelemetry.utils");
 const recordException = (span, error) => {
@@ -46,4 +46,3 @@ function Span(name, options = {}) {
         (0, opentelemetry_utils_1.copyMetadataFromFunctionToFunction)(originalFunction, wrappedFunction);
     };
 }
-exports.Span = Span;

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "nestjs-otel",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "description": "NestJS OpenTelemetry Library",
   "main": "lib/index.js",
   "typings": "lib/index",
   "scripts": {
     "prebuild": "rimraf lib",
-    "prepare": "husky install",
     "build": "tsc",
     "lint": "prettier --check ./**/*.{js,json,ts}",
     "format": "prettier --write ./**/*.{js,json,ts}",
@@ -15,7 +14,8 @@
     "test:unit": "jest --passWithNoTests",
     "test:watch": "jest --watch",
     "test:e2e": "jest --config ./tests/jest-e2e.json --runInBand --forceExit",
-    "test:e2e:watch": "jest --config ./tests/jest-e2e.json --runInBand --watch"
+    "test:e2e:watch": "jest --config ./tests/jest-e2e.json --runInBand --watch",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
@@ -36,40 +36,39 @@
   },
   "homepage": "https://github.com/pragmaticivan/nestjs-otel#readme",
   "dependencies": {
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/host-metrics": "^0.35.1",
-    "response-time": "^2.3.2"
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/host-metrics": "^0.35.4",
+    "response-time": "^2.3.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.3.0",
-    "@commitlint/config-conventional": "^19.2.2",
-    "@nestjs/common": "^10.3.8",
-    "@nestjs/core": "^10.3.8",
-    "@nestjs/platform-express": "^10.3.8",
-    "@nestjs/platform-fastify": "^10.3.8",
-    "@nestjs/testing": "^10.3.8",
-    "@opentelemetry/exporter-prometheus": "^0.51.1",
-    "@opentelemetry/sdk-metrics": "^1.24.1",
-    "@opentelemetry/sdk-trace-node": "^1.24.1",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.10",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@nestjs/common": "^10.4.8",
+    "@nestjs/core": "^10.4.8",
+    "@nestjs/platform-express": "^10.4.8",
+    "@nestjs/platform-fastify": "^10.4.8",
+    "@nestjs/testing": "^10.4.8",
+    "@opentelemetry/exporter-prometheus": "^0.54.2",
+    "@opentelemetry/sdk-metrics": "^1.27.0",
+    "@opentelemetry/sdk-trace-node": "^1.27.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.9.0",
     "@types/response-time": "^2.3.8",
     "@types/supertest": "^6.0.2",
-    "ansi-regex": "",
-    "husky": "^9.0.11",
+    "husky": "^9.1.6",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.2",
-    "prettier": "^3.2.5",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.3.3",
     "reflect-metadata": "^0.2.2",
-    "rimraf": "^5.0.5",
+    "rimraf": "^6.0.1",
     "rxjs": "^7.8.1",
     "supertest": "^7.0.0",
-    "ts-jest": "^29.1.2",
-    "typescript": "5.4.5"
+    "ts-jest": "^29.2.5",
+    "typescript": "5.6.3"
   },
   "peerDependencies": {
-    "@nestjs/common": "^9.0.0 || ^10.0.0",
-    "@nestjs/core": "^9.0.0 || ^10.0.0"
+    "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0"
   },
   "jest": {
     "moduleFileExtensions": [
@@ -93,10 +92,5 @@
     "**/*.{js,ts,json}": [
       "prettier --write"
     ]
-  },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
   }
 }

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);
-});