@rsdk/core 5.1.0-next.0 → 5.2.0-next.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.2.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.1.0...v5.2.0-next.0) (2024-10-09)
+
+### Features
+
+* **core:** opentelemetry logs exporting support [PFM-1892] ([#292](https://github.com/R-Vision/rsdk/issues/292)) ([6db5304](https://github.com/R-Vision/rsdk/commit/6db53049fd61b1307d685ec9f2684c2291257c29))
+
+## [5.1.0](https://github.com/R-Vision/rsdk/compare/v5.1.0-next.0...v5.1.0) (2024-09-03)
+
+**Note:** Version bump only for package @rsdk/core
+
 ## [5.1.0-next.0](https://github.com/R-Vision/rsdk/compare/v5.0.5-next.0...v5.1.0-next.0) (2024-09-02)
 
 **Note:** Version bump only for package @rsdk/core

package/dist/logging/logger-initializing.module.d.ts

@@ -2,4 +2,5 @@ import { LoggingConfig } from './logging.config';
 export declare class LoggerInitializingModule {
     private static logger;
     constructor(config: LoggingConfig);
+    private buildTransportOptions;
 }

package/dist/logging/logger-initializing.module.js

@@ -28,14 +28,31 @@ let LoggerInitializingModule = class LoggerInitializingModule {
             });
             logging_1.LoggerFactory.reconfigure({
                 ...config,
-                stream: pino_1.default.destination({
-                    sync: config.sync,
-                }),
+                stream: pino_1.default.transport(this.buildTransportOptions(config)),
             });
         };
         config.onUpdate(cfg);
         cfg();
     }
+    buildTransportOptions(config) {
+        const targets = [
+            {
+                target: 'pino/file',
+                options: { destination: process.stdout.fd },
+            },
+        ];
+        if (config.otelEnabled) {
+            targets.push({
+                target: 'pino-opentelemetry-transport',
+                /**
+                 * NOTE: {} required to avoid runtime error "Cannot read property 'xxx' of undefined"
+                 * (unsafe destructuring in pino-opentelemetry-transport)
+                 */
+                options: {},
+            });
+        }
+        return { targets };
+    }
 };
 exports.LoggerInitializingModule = LoggerInitializingModule;
 exports.LoggerInitializingModule = LoggerInitializingModule = LoggerInitializingModule_1 = __decorate([

package/dist/logging/logger-initializing.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger-initializing.module.js","sourceRoot":"","sources":["../../src/logging/logger-initializing.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,2CAA8C;AAC9C,gDAAwB;AAExB,qDAAiD;AAG1C,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;;IAC3B,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,0BAAwB,CAAC,CAAC;IAEvE,YAAY,MAAqB;QAC/B,MAAM,GAAG,GAAG,GAAS,EAAE;YACrB,0BAAwB,CAAC,MAAM,CAAC,IAAI,CAClC,uBAAuB,MAAM,CAAC,KAAK,GAAG,EACtC;gBACE,QAAQ,EAAE,MAAM,CAAC,KAAK;aACvB,CACF,CAAC;YAEF,uBAAa,CAAC,WAAW,CAAC;gBACxB,GAAG,MAAM;gBACT,MAAM,EAAE,cAAI,CAAC,WAAW,CAAC;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC;aACH,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,GAAG,EAAE,CAAC;IACR,CAAC;;AAtBU,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,eAAM,EAAC,EAAE,CAAC;qCAIW,8BAAa;GAHtB,wBAAwB,CAuBpC"}
+{"version":3,"file":"logger-initializing.module.js","sourceRoot":"","sources":["../../src/logging/logger-initializing.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,2CAA8C;AAE9C,gDAAwB;AAExB,qDAAiD;AAG1C,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;;IAC3B,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,0BAAwB,CAAC,CAAC;IAEvE,YAAY,MAAqB;QAC/B,MAAM,GAAG,GAAG,GAAS,EAAE;YACrB,0BAAwB,CAAC,MAAM,CAAC,IAAI,CAClC,uBAAuB,MAAM,CAAC,KAAK,GAAG,EACtC;gBACE,QAAQ,EAAE,MAAM,CAAC,KAAK;aACvB,CACF,CAAC;YAEF,uBAAa,CAAC,WAAW,CAAC;gBACxB,GAAG,MAAM;gBACT,MAAM,EAAE,cAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;aAC3D,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,GAAG,EAAE,CAAC;IACR,CAAC;IAEO,qBAAqB,CAAC,MAAqB;QACjD,MAAM,OAAO,GAA6B;YACxC;gBACE,MAAM,EAAE,WAAW;gBACnB,OAAO,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE;aAC5C;SACF,CAAC;QAEF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC;gBACX,MAAM,EAAE,8BAA8B;gBACtC;;;mBAGG;gBACH,OAAO,EAAE,EAAE;aACZ,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;;AA1CU,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,eAAM,EAAC,EAAE,CAAC;qCAIW,8BAAa;GAHtB,wBAAwB,CA2CpC"}

package/dist/logging/logging.config.d.ts

@@ -4,4 +4,5 @@ export declare class LoggingConfig extends Config {
     readonly level: LogLevel;
     readonly redact: string[];
     readonly sync: boolean;
+    readonly otelEnabled: boolean;
 }

package/dist/logging/logging.config.js

@@ -17,6 +17,7 @@ let LoggingConfig = class LoggingConfig extends config_1.Config {
     level;
     redact;
     sync;
+    otelEnabled;
 };
 exports.LoggingConfig = LoggingConfig;
 __decorate([
@@ -41,6 +42,13 @@ __decorate([
     }),
     __metadata("design:type", Boolean)
 ], LoggingConfig.prototype, "sync", void 0);
+__decorate([
+    (0, config_1.Property)('LOG_OTEL_ENABLED', new config_1.BoolParser(), {
+        defaultValue: false,
+        description: 'Enable OpenTelemetry exporter',
+    }),
+    __metadata("design:type", Boolean)
+], LoggingConfig.prototype, "otelEnabled", void 0);
 exports.LoggingConfig = LoggingConfig = __decorate([
     (0, config_1.ConfigSection)({
         tags: [config_const_1.ConfigTag.infrastructure, config_const_1.ConfigTag.logging],

package/dist/logging/logging.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"logging.config.js","sourceRoot":"","sources":["../../src/logging/logging.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwD;AAExD,sCAQmB;AACnB,yDAAmD;AAK5C,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,eAAM;IAM9B,KAAK,CAAY;IAOjB,MAAM,CAAY;IAOlB,IAAI,CAAW;CACzB,CAAA;AArBY,sCAAa;AAMf;IALR,IAAA,iBAAQ,EAAC,WAAW,EAAE,IAAI,mBAAU,CAAC,kBAAQ,CAAC,EAAE;QAC/C,sEAAsE;QACtE,YAAY,EAAE,uBAAa;QAC3B,WAAW,EAAE,WAAW;KACzB,CAAC;;4CACwB;AAOjB;IALR,IAAA,iBAAQ,EAAC,YAAY,EAAE,IAAI,oBAAW,CAAC,IAAI,qBAAY,EAAE,CAAC,EAAE;QAC3D,YAAY,EAAE,EAAE;QAChB,WAAW,EACT,gGAAgG;KACnG,CAAC;;6CACyB;AAOlB;IALR,IAAA,iBAAQ,EAAC,UAAU,EAAE,IAAI,mBAAU,EAAE,EAAE;QACtC,YAAY,EAAE,KAAK;QACnB,WAAW,EACT,wGAAwG;KAC3G,CAAC;;2CACsB;wBApBb,aAAa;IAHzB,IAAA,sBAAa,EAAC;QACb,IAAI,EAAE,CAAC,wBAAS,CAAC,cAAc,EAAE,wBAAS,CAAC,OAAO,CAAC;KACpD,CAAC;GACW,aAAa,CAqBzB"}
+{"version":3,"file":"logging.config.js","sourceRoot":"","sources":["../../src/logging/logging.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwD;AAExD,sCAQmB;AACnB,yDAAmD;AAK5C,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,eAAM;IAM9B,KAAK,CAAY;IAOjB,MAAM,CAAY;IAOlB,IAAI,CAAW;IAMf,WAAW,CAAW;CAChC,CAAA;AA3BY,sCAAa;AAMf;IALR,IAAA,iBAAQ,EAAC,WAAW,EAAE,IAAI,mBAAU,CAAC,kBAAQ,CAAC,EAAE;QAC/C,sEAAsE;QACtE,YAAY,EAAE,uBAAa;QAC3B,WAAW,EAAE,WAAW;KACzB,CAAC;;4CACwB;AAOjB;IALR,IAAA,iBAAQ,EAAC,YAAY,EAAE,IAAI,oBAAW,CAAC,IAAI,qBAAY,EAAE,CAAC,EAAE;QAC3D,YAAY,EAAE,EAAE;QAChB,WAAW,EACT,gGAAgG;KACnG,CAAC;;6CACyB;AAOlB;IALR,IAAA,iBAAQ,EAAC,UAAU,EAAE,IAAI,mBAAU,EAAE,EAAE;QACtC,YAAY,EAAE,KAAK;QACnB,WAAW,EACT,wGAAwG;KAC3G,CAAC;;2CACsB;AAMf;IAJR,IAAA,iBAAQ,EAAC,kBAAkB,EAAE,IAAI,mBAAU,EAAE,EAAE;QAC9C,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,+BAA+B;KAC7C,CAAC;;kDAC6B;wBA1BpB,aAAa;IAHzB,IAAA,sBAAa,EAAC;QACb,IAAI,EAAE,CAAC,wBAAS,CAAC,cAAc,EAAE,wBAAS,CAAC,OAAO,CAAC;KACpD,CAAC;GACW,aAAa,CA2BzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/core",
-  "version": "5.1.0-next.0",
+  "version": "5.2.0-next.0",
   "description": "Nestjs based microservice chassis",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -24,6 +24,7 @@
     "@nestjs/core": "^10.0.0",
     "@nestjs/microservices": "^10.0.0",
     "@opentelemetry/api": "1.7.0",
+    "@opentelemetry/exporter-logs-otlp-http": "0.53.0",
     "@rsdk/actx": "*",
     "@rsdk/autodoc.protocol": "*",
     "@rsdk/common": "*",
@@ -33,13 +34,20 @@
     "@rsdk/logging": "*",
     "@rsdk/metadata": "*",
     "@rsdk/nest-tools": "*",
+    "pino-opentelemetry-transport": "^1.0.1",
     "reflect-metadata": "^0.1.12 || ^0.2.0",
     "rxjs": "^7.8.1"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {
       "optional": true
+    },
+    "@opentelemetry/exporter-logs-otlp-http": {
+      "optional": true
+    },
+    "pino-opentelemetry-transport": {
+      "optional": true
     }
   },
-  "gitHead": "19ef06e2cadbdfb68d15f2b9dc1e96378e66f314"
+  "gitHead": "da77ceb328be50e1741fdc67945d373f07e01374"
 }

package/src/logging/logger-initializing.module.ts

@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
 import { LoggerFactory } from '@rsdk/logging';
+import type { TransportMultiOptions, TransportTargetOptions } from 'pino';
 import pino from 'pino';
 
 import { LoggingConfig } from './logging.config';
@@ -19,13 +20,33 @@ export class LoggerInitializingModule {
 
       LoggerFactory.reconfigure({
         ...config,
-        stream: pino.destination({
-          sync: config.sync,
-        }),
+        stream: pino.transport(this.buildTransportOptions(config)),
       });
     };
 
     config.onUpdate(cfg);
     cfg();
   }
+
+  private buildTransportOptions(config: LoggingConfig): TransportMultiOptions {
+    const targets: TransportTargetOptions[] = [
+      {
+        target: 'pino/file',
+        options: { destination: process.stdout.fd },
+      },
+    ];
+
+    if (config.otelEnabled) {
+      targets.push({
+        target: 'pino-opentelemetry-transport',
+        /**
+         * NOTE: {} required to avoid runtime error "Cannot read property 'xxx' of undefined"
+         * (unsafe destructuring in pino-opentelemetry-transport)
+         */
+        options: {},
+      });
+    }
+
+    return { targets };
+  }
 }

package/src/logging/logging.config.ts

@@ -35,4 +35,10 @@ export class LoggingConfig extends Config {
       'Synchronous logs: https://github.com/pinojs/pino/blob/master/docs/asynchronous.md#asynchronous-logging',
   })
   readonly sync!: boolean;
+
+  @Property('LOG_OTEL_ENABLED', new BoolParser(), {
+    defaultValue: false,
+    description: 'Enable OpenTelemetry exporter',
+  })
+  readonly otelEnabled!: boolean;
 }