@rsdk/logging 5.0.0-next.2 → 5.0.0-next.3

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.0.0-next.3](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.2...v5.0.0-next.3) (2024-07-11)
+
+### ⚠ BREAKING CHANGES
+
+* generalize tracing headers (#247)
+
+### Features
+
+* generalize tracing headers ([#247](https://github.com/R-Vision/rsdk/issues/247)) ([cee2ea6](https://github.com/R-Vision/rsdk/commit/cee2ea65c964705faf133397e285c051672c7512)), closes [#2](https://github.com/R-Vision/rsdk/issues/2) [#3](https://github.com/R-Vision/rsdk/issues/3) [#4](https://github.com/R-Vision/rsdk/issues/4) [#5](https://github.com/R-Vision/rsdk/issues/5)
+
 ## [5.0.0-next.2](https://github.com/R-Vision/rsdk/compare/v5.0.0-next.1...v5.0.0-next.2) (2024-07-10)
 
 **Note:** Version bump only for package @rsdk/logging

package/dist/logger.factory.d.ts

@@ -5,6 +5,18 @@ import type { LoggerOptions, LoggingContext, OnMessage } from './types';
  * Фабрика является статической потому что
  */
 export declare class LoggerFactory {
+    private static events;
+    /**
+     * Under the hood every logger instance will use this
+     * static instance. Motivation for this is that it's much
+     * easier to substitute the instance when configuration is
+     * changed.
+     *
+     * Downside is that the idea is not composable with child
+     * loggers (which are no used anywhere yet)
+     */
+    private static _globalPino;
+    private static opts;
     /**
      * Переконфигурация pino нужна потому, что изначально логгер инициализируется
      * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
@@ -24,20 +36,11 @@ export declare class LoggerFactory {
      * что мы хотим, чтобы подключение инструментирование зависело от настройки
      * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
      * конфигурации, а уже потом решать - делать инструментирование или нет.
-     */
-    static applyInstrumentations<T extends Record<string, any>>(logHookFunction?: (record: T) => void): void;
-    private static events;
-    /**
-     * Under the hood every logger instance will use this
-     * static instance. Motivation for this is that it's much
-     * easier to substitute the instance when configuration is
-     * changed.
      *
-     * Downside is that the idea is not composable with child
-     * loggers (which are no used anywhere yet)
+     * UPD: Поскольку мы не используем теперь TRACING_ENABLED и включаем трейсинг
+     * при помощи cli - можно немного упростить архитектуру
      */
-    private static _globalPino;
-    private static opts;
+    static applyInstrumentations<T extends Record<string, any>>(logHookFunction?: (record: T) => void): void;
     static onMessage(handler: OnMessage): void;
     static create(context: LoggingContext): ILogger;
     private static applyOptions;

package/dist/logger.factory.js

@@ -18,6 +18,26 @@ const requirePino = () => {
  * Фабрика является статической потому что
  */
 class LoggerFactory {
+    // eslint-disable-next-line unicorn/prefer-event-target
+    static events = new node_events_1.default();
+    /**
+     * Under the hood every logger instance will use this
+     * static instance. Motivation for this is that it's much
+     * easier to substitute the instance when configuration is
+     * changed.
+     *
+     * Downside is that the idea is not composable with child
+     * loggers (which are no used anywhere yet)
+     */
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    static _globalPino = requirePino()({
+        level: defaults_1.DEFAULT_LEVEL,
+    });
+    static opts = {
+        level: defaults_1.DEFAULT_LEVEL,
+        redact: [],
+        stream: requirePino().destination(),
+    };
     /**
      * Переконфигурация pino нужна потому, что изначально логгер инициализируется
      * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
@@ -28,7 +48,6 @@ class LoggerFactory {
     static reconfigure(opts) {
         this.applyOptions(opts);
         const { stream, ...other } = this.opts;
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
         this._globalPino = requirePino()(other, stream);
     }
     /**
@@ -42,6 +61,9 @@ class LoggerFactory {
      * что мы хотим, чтобы подключение инструментирование зависело от настройки
      * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
      * конфигурации, а уже потом решать - делать инструментирование или нет.
+     *
+     * UPD: Поскольку мы не используем теперь TRACING_ENABLED и включаем трейсинг
+     * при помощи cli - можно немного упростить архитектуру
      */
     static applyInstrumentations(logHookFunction) {
         const { stream, ...other } = this.opts;
@@ -73,26 +95,6 @@ class LoggerFactory {
                 : {},
         }, stream);
     }
-    // eslint-disable-next-line unicorn/prefer-event-target
-    static events = new node_events_1.default();
-    /**
-     * Under the hood every logger instance will use this
-     * static instance. Motivation for this is that it's much
-     * easier to substitute the instance when configuration is
-     * changed.
-     *
-     * Downside is that the idea is not composable with child
-     * loggers (which are no used anywhere yet)
-     */
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    static _globalPino = requirePino()({
-        level: defaults_1.DEFAULT_LEVEL,
-    });
-    static opts = {
-        level: defaults_1.DEFAULT_LEVEL,
-        redact: [],
-        stream: requirePino().destination(),
-    };
     static onMessage(handler) {
         this.events.on('msg', handler);
     }

package/dist/logger.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.factory.js","sourceRoot":"","sources":["../src/logger.factory.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AAIvC,yCAA2C;AAC3C,uDAA+C;AAS/C;;GAEG;AACH,MAAM,WAAW,GAAG,GAAiB,EAAE;IACrC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,aAAa;IACxB;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAA4B;QAC7C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,8DAA8D;QAC9D,IAAI,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,qBAAqB,CAC1B,eAAqC;QAErC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,8DAA8D;QAC9D,IAAI,CAAC,WAAW,GAAG,WAAW,EAAE,CAC9B;YACE,GAAG,KAAK;YACR;;eAEG;YACH,KAAK,EAAE,eAAe;gBACpB,CAAC,CAAC;oBACE;;;uBAGG;oBACH,SAAS,EAAE,UACT,SAAgB;oBAChB,wDAAwD;oBACxD,MAAgB;wBAEhB,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;4BAC1B,MAAM,IAAI,GAAM,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;4BACxC,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;4BAE/B,eAAe,CAAC,IAAI,CAAC,CAAC;4BAEtB,wDAAwD;4BACxD,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;wBACxD,CAAC;wBACD,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBACvC,CAAC;iBACF;gBACH,CAAC,CAAC,EAAE;SACP,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,uDAAuD;IAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;IAE3C;;;;;;;;OAQG;IACH,8DAA8D;IACtD,MAAM,CAAC,WAAW,GAAS,WAAW,EAAE,CAAC;QAC/C,KAAK,EAAE,wBAAa;KACrB,CAAC,CAAC;IAEK,MAAM,CAAC,IAAI,GAAkB;QACnC,KAAK,EAAE,wBAAa;QACpB,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,WAAW,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;IAEF,MAAM,CAAC,SAAS,CAAC,OAAkB;QACjC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAuB;QACnC,OAAO,IAAI,4BAAU,CACnB,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EACtB,CAAC,KAAe,EAAE,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAA4B;QACtD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QAE3E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,wBAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9E,CAAC;;AA7GH,sCA8GC"}
+{"version":3,"file":"logger.factory.js","sourceRoot":"","sources":["../src/logger.factory.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AAIvC,yCAA2C;AAC3C,uDAA+C;AAS/C;;GAEG;AACH,MAAM,WAAW,GAAG,GAAiB,EAAE;IACrC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,aAAa;IACxB,uDAAuD;IAC/C,MAAM,CAAC,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;IAE3C;;;;;;;;OAQG;IACH,8DAA8D;IACtD,MAAM,CAAC,WAAW,GAAS,WAAW,EAAE,CAAC;QAC/C,KAAK,EAAE,wBAAa;KACrB,CAAC,CAAC;IAEK,MAAM,CAAC,IAAI,GAAkB;QACnC,KAAK,EAAE,wBAAa;QACpB,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,WAAW,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAA4B;QAC7C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,IAAI,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,qBAAqB,CAC1B,eAAqC;QAErC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvC,8DAA8D;QAC9D,IAAI,CAAC,WAAW,GAAG,WAAW,EAAE,CAC9B;YACE,GAAG,KAAK;YACR;;eAEG;YACH,KAAK,EAAE,eAAe;gBACpB,CAAC,CAAC;oBACE;;;uBAGG;oBACH,SAAS,EAAE,UACT,SAAgB;oBAChB,wDAAwD;oBACxD,MAAgB;wBAEhB,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;4BAC1B,MAAM,IAAI,GAAM,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;4BACxC,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;4BAE/B,eAAe,CAAC,IAAI,CAAC,CAAC;4BAEtB,wDAAwD;4BACxD,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;wBACxD,CAAC;wBACD,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;oBACvC,CAAC;iBACF;gBACH,CAAC,CAAC,EAAE;SACP,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,OAAkB;QACjC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAuB;QACnC,OAAO,IAAI,4BAAU,CACnB,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EACtB,CAAC,KAAe,EAAE,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EACxE,OAAO,CACR,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAA4B;QACtD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QAE3E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,wBAAa,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9E,CAAC;;AA/GH,sCAgHC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/logging",
-  "version": "5.0.0-next.2",
+  "version": "5.0.0-next.3",
   "description": "Base framework independent logging functionality",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -17,5 +17,5 @@
   "peerDependencies": {
     "@rsdk/common": "*"
   },
-  "gitHead": "b1e624d9bd7734c4346cb5747feea7d2199535d0"
+  "gitHead": "c75ce1d8983ba69a6f855ba19536d28be0a9c519"
 }

package/src/logger.factory.ts

@@ -24,6 +24,29 @@ const requirePino = (): typeof _pino => {
  * Фабрика является статической потому что
  */
 export class LoggerFactory {
+  // eslint-disable-next-line unicorn/prefer-event-target
+  private static events = new EventEmitter();
+
+  /**
+   * Under the hood every logger instance will use this
+   * static instance. Motivation for this is that it's much
+   * easier to substitute the instance when configuration is
+   * changed.
+   *
+   * Downside is that the idea is not composable with child
+   * loggers (which are no used anywhere yet)
+   */
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  private static _globalPino: Pino = requirePino()({
+    level: DEFAULT_LEVEL,
+  });
+
+  private static opts: LoggerOptions = {
+    level: DEFAULT_LEVEL,
+    redact: [],
+    stream: requirePino().destination(),
+  };
+
   /**
    * Переконфигурация pino нужна потому, что изначально логгер инициализируется
    * с дефолтными настройками, т. к. конфигурация ещё не прочитана.
@@ -36,7 +59,6 @@ export class LoggerFactory {
 
     const { stream, ...other } = this.opts;
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     this._globalPino = requirePino()(other, stream);
   }
 
@@ -51,6 +73,9 @@ export class LoggerFactory {
    * что мы хотим, чтобы подключение инструментирование зависело от настройки
    * TRACING_ENABLED. Т. е. нас сначала нужно полностью инициализировать систему
    * конфигурации, а уже потом решать - делать инструментирование или нет.
+   *
+   * UPD: Поскольку мы не используем теперь TRACING_ENABLED и включаем трейсинг
+   * при помощи cli - можно немного упростить архитектуру
    */
   static applyInstrumentations<T extends Record<string, any>>(
     logHookFunction?: (record: T) => void,
@@ -93,29 +118,6 @@ export class LoggerFactory {
     );
   }
 
-  // eslint-disable-next-line unicorn/prefer-event-target
-  private static events = new EventEmitter();
-
-  /**
-   * Under the hood every logger instance will use this
-   * static instance. Motivation for this is that it's much
-   * easier to substitute the instance when configuration is
-   * changed.
-   *
-   * Downside is that the idea is not composable with child
-   * loggers (which are no used anywhere yet)
-   */
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  private static _globalPino: Pino = requirePino()({
-    level: DEFAULT_LEVEL,
-  });
-
-  private static opts: LoggerOptions = {
-    level: DEFAULT_LEVEL,
-    redact: [],
-    stream: requirePino().destination(),
-  };
-
   static onMessage(handler: OnMessage): void {
     this.events.on('msg', handler);
   }

package/src/logger.interface.ts

@@ -4,40 +4,28 @@ import type { LogLevel, Params } from './types';
 
 export interface ILogger {
   fatal(error: Error): void;
-
   fatal(message: string): void;
-
   fatal(message: string, error: Error | Params): void;
 
   error(error: Error): void;
-
   error(message: string): void;
-
   error(message: string, error: Error | Params): void;
 
   warn(message: string): void;
-
   warn(message: string, params: Params): void;
 
   info(message: string): void;
-
   info(message: string, params: Params): void;
 
   debug(message: string): void;
-
   debug(message: string, params: Params): void;
 
   trace(message: string): void;
-
   trace(message: string, params: Params): void;
 
   log(level: LogLevel, message: string): void;
-
   log(level: LogLevel, error: Error): void;
-
   log(level: LogLevel, params: Params): void;
-
   log(level: LogLevel, message: string, params?: Params): void;
-
   log(level: LogLevel, message: string, error?: ErrorLike): void;
 }