nestjs-otel 2.6.1 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+### [3.0.2](https://www.github.com/pragmaticivan/nestjs-otel/compare/v3.0.1...v3.0.2) (2022-03-24)
+
+
+### Bug Fixes
+
+* **tracing:** use startActiveSpan to ensure span in correct context ([d608b84](https://www.github.com/pragmaticivan/nestjs-otel/commit/d608b84e582b41105c6871ee2e7174f7a0116d96))
+
+### [3.0.1](https://www.github.com/pragmaticivan/nestjs-otel/compare/v3.0.0...v3.0.1) (2022-01-03)
+
+
+### Bug Fixes
+
+* **#171:** fixes missing observation callback for observable metrics ([7d89c1f](https://www.github.com/pragmaticivan/nestjs-otel/commit/7d89c1f910b28d0661da6f2989ddea4b9bdcc643)), closes [#171](https://www.github.com/pragmaticivan/nestjs-otel/issues/171)
+
+## [3.0.0](https://www.github.com/pragmaticivan/nestjs-otel/compare/v2.6.1...v3.0.0) (2021-12-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* Anything related to metrics sdk has changed. OTEL now has a stable spec and all the projects are moving towards new interfaces.
+
+### Features
+
+* ename value recorder on decorators and update readme ([646e2ea](https://www.github.com/pragmaticivan/nestjs-otel/commit/646e2eacd07127f9658b302c09d3056b3b2e1771))
+* support all metric types from otel spec ([36a7c5f](https://www.github.com/pragmaticivan/nestjs-otel/commit/36a7c5f2f895157b3e675a7a6ff6693fea6cc8f2))
+* update metric spec to the latest otel lib ([6ed63ae](https://www.github.com/pragmaticivan/nestjs-otel/commit/6ed63aefbc1e39da9659d6e232a4883f7ed93dac))
+* update packages to compply with latest otel metric spec ([943ca06](https://www.github.com/pragmaticivan/nestjs-otel/commit/943ca06ea62e95d8a07af63030609f226b78c4b8))
+
 ### [2.6.1](https://www.github.com/pragmaticivan/nestjs-otel/compare/v2.6.0...v2.6.1) (2021-10-13)
 
 

package/README.md

@@ -6,6 +6,7 @@
 
 ![Build Status](https://github.com/pragmaticivan/nestjs-otel/actions/workflows/nodejs.yml/badge.svg)
 [![NPM](https://img.shields.io/npm/v/nestjs-otel.svg)](https://www.npmjs.com/package/nestjs-otel)
+
 ## Description
 
 [OpenTelemetry](https://opentelemetry.io/) module for [Nest](https://github.com/nestjs/nest).
@@ -43,10 +44,10 @@ Some peers dependencies are required when some configurations are enabled.
 ```ts
 import {
   CompositePropagator,
-  HttpTraceContextPropagator,
-  HttpBaggagePropagator,
+  W3CTraceContextPropagator,
+  W3CBaggagePropagator,
 } from '@opentelemetry/core';
-import { BatchSpanProcessor } from '@opentelemetry/tracing';
+import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
 import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
 import { JaegerPropagator } from '@opentelemetry/propagator-jaeger';
@@ -66,8 +67,8 @@ const otelSDK = new NodeSDK({
   textMapPropagator: new CompositePropagator({
     propagators: [
       new JaegerPropagator(),
-      new HttpTraceContextPropagator(),
-      new HttpBaggagePropagator(),
+      new W3CTraceContextPropagator(),
+      new W3CBaggagePropagator(),
       new B3Propagator(),
       new B3Propagator({
         injectEncoding: B3InjectEncoding.MULTI_HEADER,
@@ -78,6 +79,7 @@ const otelSDK = new NodeSDK({
 });
 
 export default otelSDK;
+
 // You can also use the shutdown method to gracefully shut down the SDK before process shutdown
 // or on some operating system signal.
 process.on('SIGTERM', () => {
@@ -85,7 +87,7 @@ process.on('SIGTERM', () => {
     .shutdown()
     .then(
       () => console.log('SDK shut down successfully'),
-      (err) => console.log('Error shutting down SDK', err),
+      err => console.log('Error shutting down SDK', err)
     )
     .finally(() => process.exit(0));
 });
@@ -120,8 +122,9 @@ const OpenTelemetryModuleConfig = OpenTelemetryModule.forRoot({
     apiMetrics: {
       enable: true, // Includes api metrics
       timeBuckets: [], // You can change the default time buckets
-      defaultLabels: { // You can set default labels for api metrics
-        custom: 'label'
+      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
@@ -130,9 +133,7 @@ const OpenTelemetryModuleConfig = OpenTelemetryModule.forRoot({
 });
 
 @Module({
-  imports: [
-    OpenTelemetryModuleConfig,
-  ],
+  imports: [OpenTelemetryModuleConfig],
 })
 export class AppModule {}
 ```
@@ -179,7 +180,7 @@ export class BookService {
 
 ## Metric Service
 
-[OpenTelemetry Metrics](https://www.npmjs.com/package/@opentelemetry/metrics) allow a user to collect data and export it to metrics backend like Prometheus.
+[OpenTelemetry Metrics](https://www.npmjs.com/package/@opentelemetry/api-metrics) allow a user to collect data and export it to metrics backend like Prometheus.
 
 ```ts
 import { MetricService } from 'nestjs-otel';
@@ -210,9 +211,7 @@ If you want to count how many instance of a specific class has been created:
 
 ```ts
 @OtelInstanceCounter() // It will generate a counter called: app_MyClass_instances_total.
-export class MyClass {
-
-}
+export class MyClass {}
 ```
 
 ### Metric Class Method
@@ -223,9 +222,7 @@ If you want to increment a counter on each call of a specific method:
 @Injectable()
 export class MyService {
   @OtelMethodCounter()
-  doSomething() {
-
-  }
+  doSomething() {}
 }
 @Controller()
 export class AppController {
@@ -241,9 +238,12 @@ export class AppController {
 
 You have the following decorators:
 
-* `@OtelCounter()`
-* `@OtelUpDownCounter()`
-* `@OtelValueRecorder()`
+- `@OtelCounter()`
+- `@OtelUpDownCounter()`
+- `@OtelHistogram()`
+- `@OtelObservableGauge()`
+- `@OtelObservableCounter()`
+- `@OtelObservableUpDownCounter()`
 
 Example of usage:
 
@@ -253,31 +253,29 @@ import { Counter } from '@opentelemetry/api-metrics';
 
 @Controller()
 export class AppController {
-
   @Get('/home')
   home(
-    @OtelCounter('app_counter_1_inc', { description: 'counter 1 description' }) counter1: Counter,
+    @OtelCounter('app_counter_1_inc', { description: 'counter 1 description' }) counter1: Counter
   ) {
-    counter1.inc(1);
+    counter1.add(1);
   }
 }
-
 ```
 
 ## API Metrics with Middleware
 
-Impl |Metric |Description| Labels | Metric Type
---- | --- | --- | --- | ---
-| ✅ | http_request_total | Total number of HTTP requests.| method, path | Counter |
-| ✅ | http_response_total| Total number of HTTP responses.| method, status, path | Counter |
-| ✅ | http_response_success_total| Total number of all successful responses.| - | Counter |
-| ✅ | http_response_error_total| Total number of all response errors.| - | Counter |
-| ✅ | http_request_duration_seconds | HTTP latency value recorder in seconds. | method, status, path | ValueRecorder |
-| ✅ | http_client_error_total | Total number of client error requests. | - | Counter |
-| ✅ | http_server_error_total | Total number of server error requests. | - | Counter |
-| ✅ | http_server_aborts_total | Total number of data transfers aborted. | - | Counter |
-| ✅ | http_request_size_bytes | Current total of incoming bytes. | - | ValueRecorder|
-| ✅ | http_response_size_bytes | Current total of outgoing bytes. | - | ValueRecorder |
+| Impl | Metric                        | Description                               | Labels               | Metric Type |
+| ---- | ----------------------------- | ----------------------------------------- | -------------------- | ----------- |
+| ✅   | http_request_total            | Total number of HTTP requests.            | method, path         | Counter     |
+| ✅   | http_response_total           | Total number of HTTP responses.           | method, status, path | Counter     |
+| ✅   | http_response_success_total   | Total number of all successful responses. | -                    | Counter     |
+| ✅   | http_response_error_total     | Total number of all response errors.      | -                    | Counter     |
+| ✅   | http_request_duration_seconds | HTTP latency value recorder in seconds.   | method, status, path | Histogram   |
+| ✅   | http_client_error_total       | Total number of client error requests.    | -                    | Counter     |
+| ✅   | http_server_error_total       | Total number of server error requests.    | -                    | Counter     |
+| ✅   | http_server_aborts_total      | Total number of data transfers aborted.   | -                    | Counter     |
+| ✅   | http_request_size_bytes       | Current total of incoming bytes.          | -                    | Histogram   |
+| ✅   | http_response_size_bytes      | Current total of outgoing bytes.          | -                    | Histogram   |
 
 ## Prometheus Metrics
 
@@ -285,7 +283,21 @@ When `metricExporter` is defined in otel SDK with a `PrometheusExporter`it will
 
 ## Using with a logger
 
-### Pino
+### Pino with instrumentation
+
+This approach uses otel instrumentation to automatically inject spanId and traceId.
+
+```ts
+import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
+
+const otelSDK = new NodeSDK({
+  instrumentations: [new PinoInstrumentation()],
+});
+```
+
+### Pino with custom formatter
+
+This approach uses the global trace context for injecting SpanId and traceId as a property of your structured log.
 
 ```ts
 import Pino, { Logger } from 'pino';
@@ -318,7 +330,6 @@ Logs are automatically associated with tracing (Loki + Tempo):
 
 ![Loki](./examples/nestjs-prom-grafana-tempo/loki-logs.png)
 
-
 ## Stargazers over time
 
 [![Stargazers over time](https://starchart.cc/pragmaticivan/nestjs-otel.svg)](https://starchart.cc/pragmaticivan/nestjs-otel)

package/examples/nestjs-prom-grafana-tempo/package.json

@@ -21,50 +21,53 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@nestjs/common": "^8.0.5",
-    "@nestjs/core": "^8.0.5",
-    "@nestjs/platform-express": "^8.0.5",
-    "@nestjs/swagger": "^5.0.9",
-    "@opentelemetry/auto-instrumentations-node": "^0.24.0",
-    "@opentelemetry/core": "^0.24.0",
-    "@opentelemetry/exporter-jaeger": "^0.24.0",
-    "@opentelemetry/exporter-prometheus": "^0.24.0",
-    "@opentelemetry/host-metrics": "^0.24.0",
-    "@opentelemetry/metrics": "^0.24.0",
-    "@opentelemetry/propagator-b3": "^0.24.0",
-    "@opentelemetry/propagator-jaeger": "^0.24.0",
-    "@opentelemetry/sdk-node": "^0.24.0",
-    "@opentelemetry/tracing": "^0.24.0",
-    "nestjs-otel": "^2.1.0",
-    "nestjs-pino": "^1.4.0",
-    "opentelemetry-node-metrics": "^1.0.2",
-    "pino": "^6.13.0",
+    "@nestjs/common": "^8.2.4",
+    "@nestjs/core": "^8.2.4",
+    "@nestjs/platform-express": "^8.2.4",
+    "@nestjs/swagger": "^5.1.5",
+    "@opentelemetry/auto-instrumentations-node": "^0.27.1",
+    "@opentelemetry/core": "^1.0.1",
+    "@opentelemetry/exporter-jaeger": "^1.0.1",
+    "@opentelemetry/exporter-prometheus": "^0.27.0",
+    "@opentelemetry/host-metrics": "^0.27.0",
+    "@opentelemetry/instrumentation-graphql": "^0.27.1",
+    "@opentelemetry/propagator-b3": "^1.0.1",
+    "@opentelemetry/propagator-jaeger": "^1.0.1",
+    "@opentelemetry/sdk-node": "^0.27.0",
+    "@types/graphql": "^14.5.0",
+    "nestjs-otel": "^3.0.0",
+    "nestjs-pino": "^2.4.0",
+    "opentelemetry-node-metrics": "^1.1.0",
+    "pino": "^7.6.2",
+    "pino-http": "^6.5.0",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
-    "rxjs": "^7.3.0",
-    "swagger-ui-express": "^4.1.6"
+    "rxjs": "^7.5.1",
+    "swagger-ui-express": "^4.3.0"
   },
   "devDependencies": {
-    "@nestjs/cli": "^8.1.1",
-    "@nestjs/schematics": "^8.0.2",
-    "@nestjs/testing": "^8.0.5",
+    "@nestjs/cli": "^8.1.6",
+    "@nestjs/schematics": "^8.0.5",
+    "@nestjs/testing": "^8.2.4",
+    "@opentelemetry/api-metrics": "^0.27.0",
     "@types/express": "^4.17.13",
-    "@types/jest": "^26.0.24",
-    "@types/node": "^16.4.10",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^17.0.5",
+    "@types/pino-http": "^5.8.1",
     "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^4.29.0",
-    "@typescript-eslint/parser": "^4.29.0",
-    "eslint": "^7.32.0",
+    "@typescript-eslint/eslint-plugin": "^5.8.1",
+    "@typescript-eslint/parser": "^5.8.1",
+    "eslint": "^8.5.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27.0.6",
-    "prettier": "^2.3.2",
-    "supertest": "^6.1.4",
-    "ts-jest": "^27.0.4",
-    "ts-loader": "^9.2.4",
-    "ts-node": "^10.1.0",
-    "tsconfig-paths": "^3.10.1",
-    "typescript": "^4.3.5"
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.4.5",
+    "prettier": "^2.5.1",
+    "supertest": "^6.1.6",
+    "ts-jest": "^27.1.2",
+    "ts-loader": "^9.2.6",
+    "ts-node": "^10.4.0",
+    "tsconfig-paths": "^3.12.0",
+    "typescript": "^4.5.4"
   },
   "jest": {
     "moduleFileExtensions": [

package/examples/nestjs-prom-grafana-tempo/src/tracing.ts

@@ -1,9 +1,9 @@
 import {
   CompositePropagator,
-  HttpTraceContextPropagator,
-  HttpBaggagePropagator,
+  W3CTraceContextPropagator,
+  W3CBaggagePropagator,
 } from '@opentelemetry/core';
-import { BatchSpanProcessor } from '@opentelemetry/tracing';
+import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { JaegerExporter } from '@opentelemetry/exporter-jaeger';
 import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
 import { JaegerPropagator } from '@opentelemetry/propagator-jaeger';
@@ -23,8 +23,8 @@ const otelSDK = new NodeSDK({
   textMapPropagator: new CompositePropagator({
     propagators: [
       new JaegerPropagator(),
-      new HttpTraceContextPropagator(),
-      new HttpBaggagePropagator(),
+      new W3CTraceContextPropagator(),
+      new W3CBaggagePropagator(),
       new B3Propagator(),
       new B3Propagator({
         injectEncoding: B3InjectEncoding.MULTI_HEADER,

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

@@ -1,5 +1,5 @@
 import { ModuleMetadata, Type, Abstract } from '@nestjs/common';
-import { Labels } from '@opentelemetry/api-metrics';
+import { Attributes } from '@opentelemetry/api-metrics';
 import { RouteInfo } from '@nestjs/common/interfaces';
 export declare type OpenTelemetryModuleOptions = {
     metrics?: OpenTelemetryMetrics;
@@ -22,7 +22,7 @@ export declare type OpenTelemetryMetrics = {
         timeBuckets?: number[];
         requestSizeBuckets?: number[];
         responseSizeBuckets?: number[];
-        defaultLabels?: Labels;
+        defaultAttributes?: Attributes;
         ignoreRoutes?: (string | RouteInfo)[];
         ignoreUndefinedRoutes?: boolean;
     };

package/lib/metrics/decorators/common.js

@@ -9,7 +9,7 @@ const OtelInstanceCounter = (options) => (ctor) => {
     return class extends ctor {
         constructor(...args) {
             if (!counterMetric) {
-                counterMetric = (0, metric_data_1.getOrCreateCounter)(name, metric_data_1.MetricType.Counter, { description, ...options });
+                counterMetric = (0, metric_data_1.getOrCreateCounter)(name, { description, ...options });
             }
             counterMetric.add(1);
             super(...args);
@@ -25,7 +25,7 @@ const OtelMethodCounter = (options) => (target, propertyKey, descriptor) => {
     const methodFunc = descriptor.value;
     descriptor.value = function (...args) {
         if (!counterMetric) {
-            counterMetric = (0, metric_data_1.getOrCreateCounter)(name, metric_data_1.MetricType.Counter, { description, ...options });
+            counterMetric = (0, metric_data_1.getOrCreateCounter)(name, { description, ...options });
         }
         counterMetric.add(1);
         return methodFunc.apply(this, args);

package/lib/metrics/decorators/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/metrics/decorators/common.ts"],"names":[],"mappings":";;;AACA,gDAA0F;AAOnF,MAAM,mBAAmB,GAAG,CACjC,OAAuB,EACvB,EAAE,CAAC,CAAwC,IAAO,EAAE,EAAE;IACtD,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,kBAAkB,CAAC;IAChD,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAC9D,IAAI,aAAsB,CAAC;IAE3B,OAAO,KAAM,SAAQ,IAAI;QACvB,YAAY,GAAG,IAAI;YACjB,IAAI,CAAC,aAAa,EAAE;gBAClB,aAAa,GAAG,IAAA,gCAAkB,EAAC,IAAI,EAAE,wBAAU,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;aAC3F;YAED,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,mBAAmB,uBAiB9B;AAKK,MAAM,iBAAiB,GAAG,CAC/B,OAAuB,EACvB,EAAE,CAAC,CACH,MAAc,EAAE,WAA4B,EAAE,UACrC,EACT,EAAE;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE,cAAc,CAAC;IACtE,MAAM,WAAW,GAAG,OAAO,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE,eAAe,CAAC;IAC9E,IAAI,aAAsB,CAAC;IAC3B,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC;IAEpC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;QACzC,IAAI,CAAC,aAAa,EAAE;YAClB,aAAa,GAAG,IAAA,gCAAkB,EAAC,IAAI,EAAE,wBAAU,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;SAC3F;QACD,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrB,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,iBAAiB,qBAmB5B"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/metrics/decorators/common.ts"],"names":[],"mappings":";;;AACA,gDAAoD;AAO7C,MAAM,mBAAmB,GAAG,CACjC,OAAuB,EACvB,EAAE,CAAC,CAAwC,IAAO,EAAE,EAAE;IACtD,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,IAAI,kBAAkB,CAAC;IAChD,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,IAAI,yBAAyB,CAAC;IAC9D,IAAI,aAAsB,CAAC;IAE3B,OAAO,KAAM,SAAQ,IAAI;QACvB,YAAY,GAAG,IAAI;YACjB,IAAI,CAAC,aAAa,EAAE;gBAClB,aAAa,GAAG,IAAA,gCAAkB,EAAC,IAAI,EAAE,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;aACvE;YAED,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,mBAAmB,uBAiB9B;AAKK,MAAM,iBAAiB,GAAG,CAC/B,OAAuB,EACvB,EAAE,CAAC,CACH,MAAc,EACd,WAA4B,EAC5B,UACS,EACT,EAAE;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE,cAAc,CAAC;IACtE,MAAM,WAAW,GAAG,OAAO,SAAS,IAAI,WAAW,CAAC,QAAQ,EAAE,eAAe,CAAC;IAC9E,IAAI,aAAsB,CAAC;IAC3B,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC;IAEpC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;QACzC,IAAI,CAAC,aAAa,EAAE;YAClB,aAAa,GAAG,IAAA,gCAAkB,EAAC,IAAI,EAAE,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;SACvE;QACD,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrB,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,iBAAiB,qBAqB5B"}

package/lib/metrics/decorators/counter.js

@@ -7,12 +7,12 @@ 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, metric_data_1.MetricType.Counter, options);
+    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, metric_data_1.MetricType.UpDownCounter, options);
+    return (0, metric_data_1.getOrCreateCounter)(name, options);
 });
 //# sourceMappingURL=counter.js.map

package/lib/metrics/decorators/counter.js.map

@@ -1 +1 @@
-{"version":3,"file":"counter.js","sourceRoot":"","sources":["../../../src/metrics/decorators/counter.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,gDAA0F;AAE7E,QAAA,WAAW,GAAG,IAAA,6BAAoB,EAAC,CAC9C,IAAY,EAAE,OAAuB,EACrC,EAAE;IACF,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IACD,OAAO,IAAA,gCAAkB,EAAC,IAAI,EAAE,wBAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,CACpD,IAAY,EAAE,OAAuB,EACrC,EAAE;IACF,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IACD,OAAO,IAAA,gCAAkB,EAAC,IAAI,EAAE,wBAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC"}
+{"version":3,"file":"counter.js","sourceRoot":"","sources":["../../../src/metrics/decorators/counter.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,gDAAgE;AAEnD,QAAA,WAAW,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IACxF,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IACD,OAAO,IAAA,gCAAkB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IAC9F,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IACD,OAAO,IAAA,gCAAkB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3C,CAAC,CAAC,CAAC"}

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

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

@@ -0,0 +1,12 @@
+"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);
+});
+//# sourceMappingURL=histogram.js.map

package/lib/metrics/decorators/histogram.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"histogram.js","sourceRoot":"","sources":["../../../src/metrics/decorators/histogram.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,gDAAsD;AAEzC,QAAA,aAAa,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IAC1F,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;IACD,OAAO,IAAA,kCAAoB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC"}

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

@@ -1,3 +1,4 @@
 export * from './common';
 export * from './counter';
-export * from './value-recorder';
+export * from './histogram';
+export * from './observable';

package/lib/metrics/decorators/index.js

@@ -12,5 +12,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
 __exportStar(require("./counter"), exports);
-__exportStar(require("./value-recorder"), exports);
+__exportStar(require("./histogram"), exports);
+__exportStar(require("./observable"), exports);
 //# sourceMappingURL=index.js.map

package/lib/metrics/decorators/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/metrics/decorators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B;AAC1B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/metrics/decorators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B;AAC1B,8CAA4B;AAC5B,+CAA6B"}

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

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

@@ -0,0 +1,24 @@
+"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);
+});
+//# sourceMappingURL=observable.js.map

package/lib/metrics/decorators/observable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observable.js","sourceRoot":"","sources":["../../../src/metrics/decorators/observable.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,gDAA8H;AAEjH,QAAA,mBAAmB,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IAChG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;KAC7D;IACD,OAAO,IAAA,wCAA0B,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC,CAAC,CAAC;AAEU,QAAA,qBAAqB,GAAG,IAAA,6BAAoB,EACvD,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IACxC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IACD,OAAO,IAAA,0CAA4B,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC,CACF,CAAC;AAEW,QAAA,2BAA2B,GAAG,IAAA,6BAAoB,EAC7D,CAAC,IAAY,EAAE,OAAuB,EAAE,EAAE;IACxC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IACD,OAAO,IAAA,gDAAkC,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC,CACF,CAAC"}

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

@@ -1,10 +1,17 @@
-import { Counter, MetricOptions, UpDownCounter, ValueRecorder } from '@opentelemetry/api-metrics';
-export declare type GenericMetric = Counter | UpDownCounter | ValueRecorder;
+import { Counter, MetricOptions, UpDownCounter, Histogram, ObservableGauge, ObservableCounter, ObservableUpDownCounter, ObservableResult } from '@opentelemetry/api-metrics';
+export declare type GenericMetric = Counter | UpDownCounter | Histogram | ObservableGauge | ObservableCounter | ObservableUpDownCounter;
 export declare enum MetricType {
     'Counter' = "Counter",
     'UpDownCounter' = "UpDownCounter",
-    'ValueRecorder' = "ValueRecorder"
+    'Histogram' = "Histogram",
+    'ObservableGauge' = "ObservableGauge",
+    'ObservableCounter' = "ObservableCounter",
+    'ObservableUpDownCounter' = "ObservableUpDownCounter"
 }
 export declare const meterData: Map<string, GenericMetric>;
-export declare function getOrCreateValueRecorder(name: string, type: MetricType, options: MetricOptions): ValueRecorder;
-export declare function getOrCreateCounter(name: string, type: MetricType, options: MetricOptions): Counter | UpDownCounter;
+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, callback?: (observableResult: ObservableResult) => void): ObservableGauge;
+export declare function getOrCreateObservableCounter(name: string, options: MetricOptions, callback?: (observableResult: ObservableResult) => void): ObservableCounter;
+export declare function getOrCreateObservableUpDownCounter(name: string, options: MetricOptions, callback?: (observableResult: ObservableResult) => void): ObservableUpDownCounter;

package/lib/metrics/metric-data.js

@@ -1,47 +1,76 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrCreateCounter = exports.getOrCreateValueRecorder = exports.meterData = exports.MetricType = void 0;
+exports.getOrCreateObservableUpDownCounter = exports.getOrCreateObservableCounter = exports.getOrCreateObservableGauge = exports.getOrCreateUpDownCounter = exports.getOrCreateCounter = exports.getOrCreateHistogram = exports.meterData = exports.MetricType = void 0;
 const api_metrics_1 = require("@opentelemetry/api-metrics");
 const opentelemetry_constants_1 = require("../opentelemetry.constants");
 var MetricType;
 (function (MetricType) {
     MetricType["Counter"] = "Counter";
     MetricType["UpDownCounter"] = "UpDownCounter";
-    MetricType["ValueRecorder"] = "ValueRecorder";
+    MetricType["Histogram"] = "Histogram";
+    MetricType["ObservableGauge"] = "ObservableGauge";
+    MetricType["ObservableCounter"] = "ObservableCounter";
+    MetricType["ObservableUpDownCounter"] = "ObservableUpDownCounter";
 })(MetricType = exports.MetricType || (exports.MetricType = {}));
 exports.meterData = new Map();
-function getOrCreateValueRecorder(name, type, options) {
+function getOrCreateHistogram(name, options) {
     if (exports.meterData.has(name)) {
         return exports.meterData.get(name);
     }
     const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    switch (type) {
-        case MetricType.ValueRecorder:
-            const valueRecorder = meter.createValueRecorder(name, options);
-            exports.meterData.set(name, valueRecorder);
-            return valueRecorder;
-        default:
-            throw new Error(`Unknown type: ${type}`);
+    const histogram = meter.createHistogram(name, options);
+    exports.meterData.set(name, histogram);
+    return histogram;
+}
+exports.getOrCreateHistogram = getOrCreateHistogram;
+function getOrCreateCounter(name, options) {
+    if (exports.meterData.has(name)) {
+        return exports.meterData.get(name);
     }
+    const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
+    const counter = meter.createCounter(name, options);
+    exports.meterData.set(name, counter);
+    return counter;
 }
-exports.getOrCreateValueRecorder = getOrCreateValueRecorder;
-function getOrCreateCounter(name, type, options) {
+exports.getOrCreateCounter = getOrCreateCounter;
+function getOrCreateUpDownCounter(name, options) {
     if (exports.meterData.has(name)) {
         return exports.meterData.get(name);
     }
     const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
-    switch (type) {
-        case MetricType.Counter:
-            const counter = meter.createCounter(name, options);
-            exports.meterData.set(name, counter);
-            return counter;
-        case MetricType.UpDownCounter:
-            const upDownCounter = meter.createUpDownCounter(name, options);
-            exports.meterData.set(name, upDownCounter);
-            return upDownCounter;
-        default:
-            throw new Error(`Unknown type: ${type}`);
+    const upDownCounter = meter.createUpDownCounter(name, options);
+    exports.meterData.set(name, upDownCounter);
+    return upDownCounter;
+}
+exports.getOrCreateUpDownCounter = getOrCreateUpDownCounter;
+function getOrCreateObservableGauge(name, options, callback) {
+    if (exports.meterData.has(name)) {
+        return exports.meterData.get(name);
     }
+    const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
+    const observableGauge = meter.createObservableGauge(name, options, callback);
+    exports.meterData.set(name, observableGauge);
+    return observableGauge;
 }
-exports.getOrCreateCounter = getOrCreateCounter;
+exports.getOrCreateObservableGauge = getOrCreateObservableGauge;
+function getOrCreateObservableCounter(name, options, callback) {
+    if (exports.meterData.has(name)) {
+        return exports.meterData.get(name);
+    }
+    const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
+    const observableCounter = meter.createObservableCounter(name, options, callback);
+    exports.meterData.set(name, observableCounter);
+    return observableCounter;
+}
+exports.getOrCreateObservableCounter = getOrCreateObservableCounter;
+function getOrCreateObservableUpDownCounter(name, options, callback) {
+    if (exports.meterData.has(name)) {
+        return exports.meterData.get(name);
+    }
+    const meter = api_metrics_1.metrics.getMeterProvider().getMeter(opentelemetry_constants_1.OTEL_METER_NAME);
+    const observableCounter = meter.createObservableCounter(name, options, callback);
+    exports.meterData.set(name, observableCounter);
+    return observableCounter;
+}
+exports.getOrCreateObservableUpDownCounter = getOrCreateObservableUpDownCounter;
 //# sourceMappingURL=metric-data.js.map