@rsdk/grpc.server 3.7.0 → 3.8.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.8.0](https://github.com/R-Vision/rsdk/compare/v3.7.0...v3.8.0) (2023-11-15)
+
+### Features
+
+* added configuration for request logging and move to trace level all request logging ([#158](https://github.com/R-Vision/rsdk/issues/158)) ([0304672](https://github.com/R-Vision/rsdk/commit/0304672c112fd626642a2d44b0384fbf188e71b4))
+
 ## [3.7.0](https://github.com/R-Vision/rsdk/compare/v3.6.1...v3.7.0) (2023-11-15)
 
 ### Features

package/dist/grpc-logger.interceptor.d.ts

@@ -1,8 +1,10 @@
 import type { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common/interfaces';
 import { ILogger } from '@rsdk/logging';
 import type { Observable } from 'rxjs';
+import { GRPCConfig } from './grpc.config';
 export declare class GrpcLoggerInterceptor implements NestInterceptor {
     private logger;
-    constructor(logger: ILogger);
+    private grpcConfig;
+    constructor(logger: ILogger, grpcConfig: GRPCConfig);
     intercept(context: ExecutionContext, next: CallHandler<any>): Observable<any> | Promise<Observable<any>>;
 }

package/dist/grpc-logger.interceptor.js

@@ -15,45 +15,58 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GrpcLoggerInterceptor = void 0;
 const core_1 = require("@rsdk/core");
 const rxjs_1 = require("rxjs");
+const grpc_config_1 = require("./grpc.config");
 let GrpcLoggerInterceptor = exports.GrpcLoggerInterceptor = class GrpcLoggerInterceptor {
     logger;
-    constructor(logger) {
+    grpcConfig;
+    constructor(logger, grpcConfig) {
         this.logger = logger;
+        this.grpcConfig = grpcConfig;
     }
     intercept(context, next) {
+        if (!this.grpcConfig.requestLogging) {
+            return next.handle();
+        }
         const isRpc = context.getType() === 'rpc';
         if (!isRpc) {
             return next.handle();
         }
         const rpc = context.switchToRpc();
-        const now = Date.now();
+        const startDate = Date.now();
         const rpcContext = rpc.getContext();
         const serializedCtx = rpcContext?.toJSON?.() ?? rpcContext;
         const requestForLog = {
             data: rpc.getData(),
             ctx: serializedCtx,
         };
-        this.logger.debug('received rpc request', {
+        this.logger.trace('received rpc request', {
             request: requestForLog,
-            timestamp: now,
+            timestamp: startDate,
         });
-        return next.handle().pipe((0, rxjs_1.catchError)((err) => {
-            this.logger.debug('handled rpc request with error', {
+        return next.handle().pipe((0, rxjs_1.catchError)((error) => {
+            const endDate = Date.now();
+            this.logger.trace('handled rpc request with error', {
                 request: requestForLog,
-                start: now,
-                end: Date.now() - now,
-                err,
+                startDate,
+                endDate,
+                duration: endDate - startDate,
+                error,
             });
-            return (0, rxjs_1.throwError)(() => err);
-        }), (0, rxjs_1.tap)(() => this.logger.debug('handled rpc request', {
-            request: requestForLog,
-            start: now,
-            end: Date.now() - now,
-        })));
+            return (0, rxjs_1.throwError)(() => error);
+        }), (0, rxjs_1.tap)((response) => {
+            const endDate = Date.now();
+            this.logger.trace('handled rpc request', {
+                request: requestForLog,
+                startDate,
+                endDate,
+                duration: endDate - startDate,
+                response,
+            });
+        }));
     }
 };
 exports.GrpcLoggerInterceptor = GrpcLoggerInterceptor = __decorate([
     __param(0, (0, core_1.InjectLogger)(GrpcLoggerInterceptor)),
-    __metadata("design:paramtypes", [Object])
+    __metadata("design:paramtypes", [Object, grpc_config_1.GRPCConfig])
 ], GrpcLoggerInterceptor);
 //# sourceMappingURL=grpc-logger.interceptor.js.map

package/dist/grpc-logger.interceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc-logger.interceptor.js","sourceRoot":"","sources":["../src/grpc-logger.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,qCAA0C;AAG1C,+BAAmD;AAEnD,IAAa,qBAAqB,mCAAlC,MAAa,qBAAqB;IACyB;IAAzD,YAAyD,MAAe;QAAf,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;IAE5E,SAAS,CACP,OAAyB,EACzB,IAAsB;QAEtB,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,KAAK,KAAK,CAAC;QAC1C,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACtB;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QAElC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;QACpC,MAAM,aAAa,GAAG,UAAU,EAAE,MAAM,EAAE,EAAE,IAAI,UAAU,CAAC;QAC3D,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;YACnB,GAAG,EAAE,aAAa;SACnB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;YACxC,OAAO,EAAE,aAAa;YACtB,SAAS,EAAE,GAAG;SACf,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CACvB,IAAA,iBAAU,EAAC,CAAC,GAAG,EAAE,EAAE;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;gBAClD,OAAO,EAAE,aAAa;gBACtB,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG;gBACrB,GAAG;aACJ,CAAC,CAAC;YACH,OAAO,IAAA,iBAAU,EAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC,CAAC,EACF,IAAA,UAAG,EAAC,GAAG,EAAE,CACP,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE;YACvC,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,GAAG;YACV,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG;SACtB,CAAC,CACH,CACF,CAAC;IACJ,CAAC;CACF,CAAA;gCA9CY,qBAAqB;IACnB,WAAA,IAAA,mBAAY,EAAC,qBAAqB,CAAC,CAAA;;GADrC,qBAAqB,CA8CjC"}
+{"version":3,"file":"grpc-logger.interceptor.js","sourceRoot":"","sources":["../src/grpc-logger.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,qCAA0C;AAG1C,+BAAmD;AAEnD,+CAA2C;AAE3C,IAAa,qBAAqB,mCAAlC,MAAa,qBAAqB;IAEe;IACrC;IAFV,YAC+C,MAAe,EACpD,UAAsB;QADe,WAAM,GAAN,MAAM,CAAS;QACpD,eAAU,GAAV,UAAU,CAAY;IAC7B,CAAC;IAEJ,SAAS,CACP,OAAyB,EACzB,IAAsB;QAEtB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE;YACnC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACtB;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,KAAK,KAAK,CAAC;QAC1C,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACtB;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QAElC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC;QACpC,MAAM,aAAa,GAAG,UAAU,EAAE,MAAM,EAAE,EAAE,IAAI,UAAU,CAAC;QAC3D,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;YACnB,GAAG,EAAE,aAAa;SACnB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE;YACxC,OAAO,EAAE,aAAa;YACtB,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CACvB,IAAA,iBAAU,EAAC,CAAC,KAAK,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;gBAClD,OAAO,EAAE,aAAa;gBACtB,SAAS;gBACT,OAAO;gBACP,QAAQ,EAAE,OAAO,GAAG,SAAS;gBAC7B,KAAK;aACN,CAAC,CAAC;YACH,OAAO,IAAA,iBAAU,EAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC,EACF,IAAA,UAAG,EAAC,CAAC,QAAQ,EAAE,EAAE;YACf,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE;gBACvC,OAAO,EAAE,aAAa;gBACtB,SAAS;gBACT,OAAO;gBACP,QAAQ,EAAE,OAAO,GAAG,SAAS;gBAC7B,QAAQ;aACT,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF,CAAA;gCA3DY,qBAAqB;IAE7B,WAAA,IAAA,mBAAY,EAAC,qBAAqB,CAAC,CAAA;6CAChB,wBAAU;GAHrB,qBAAqB,CA2DjC"}

package/dist/grpc.config.d.ts

@@ -3,4 +3,5 @@ export declare class GRPCConfig extends Config {
     readonly address: string;
     readonly maxRecv: number;
     readonly maxSend: number;
+    readonly requestLogging: boolean;
 }

package/dist/grpc.config.js

@@ -18,6 +18,7 @@ let GRPCConfig = exports.GRPCConfig = class GRPCConfig extends core_1.Config {
     address;
     maxRecv;
     maxSend;
+    requestLogging;
 };
 __decorate([
     (0, core_1.Property)('GRPC_ADDRESS', new grpc_common_1.GrpcAddressParser(), {
@@ -43,6 +44,13 @@ __decorate([
     }),
     __metadata("design:type", Number)
 ], GRPCConfig.prototype, "maxSend", void 0);
+__decorate([
+    (0, core_1.Property)('GRPC_REQUEST_LOGGING', new core_1.BoolParser(), {
+        defaultValue: false,
+        description: 'Enable trace logging all requests',
+    }),
+    __metadata("design:type", Boolean)
+], GRPCConfig.prototype, "requestLogging", void 0);
 exports.GRPCConfig = GRPCConfig = __decorate([
     (0, core_1.ConfigSection)({
         tags: [core_1.ConfigTag.infrastructure, core_1.ConfigTag.transport, core_1.ConfigTag.grpcServer],

package/dist/grpc.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc.config.js","sourceRoot":"","sources":["../src/grpc.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iEAG2C;AAC3C,yCAAoC;AACpC,qCAMoB;AACpB,mDAAsD;AAK/C,IAAM,UAAU,wBAAhB,MAAM,UAAW,SAAQ,aAAM;IAQ3B,OAAO,CAAU;IAMjB,OAAO,CAAU;IAMjB,OAAO,CAAU;CAC3B,CAAA;AAbU;IAPR,IAAA,eAAQ,EAAC,cAAc,EAAE,IAAI,+BAAiB,EAAE,EAAE;QACjD,YAAY,EAAE,eAAe;QAC7B,WAAW,EAAE,IAAA,aAAI,EAAA;;;KAGhB;KACF,CAAC;;2CACwB;AAMjB;IAJR,IAAA,eAAQ,EAAC,iCAAiC,EAAE,IAAI,gBAAS,EAAE,EAAE;QAC5D,YAAY,EAAE,8CAAkC;QAChD,WAAW,EAAE,iCAAiC;KAC/C,CAAC;;2CACwB;AAMjB;IAJR,IAAA,eAAQ,EAAC,8BAA8B,EAAE,IAAI,gBAAS,EAAE,EAAE;QACzD,YAAY,EAAE,2CAA+B;QAC7C,WAAW,EAAE,8BAA8B;KAC5C,CAAC;;2CACwB;qBApBf,UAAU;IAHtB,IAAA,oBAAa,EAAC;QACb,IAAI,EAAE,CAAC,gBAAS,CAAC,cAAc,EAAE,gBAAS,CAAC,SAAS,EAAE,gBAAS,CAAC,UAAU,CAAC;KAC5E,CAAC;GACW,UAAU,CAqBtB"}
+{"version":3,"file":"grpc.config.js","sourceRoot":"","sources":["../src/grpc.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iEAG2C;AAC3C,yCAAoC;AACpC,qCAOoB;AACpB,mDAAsD;AAK/C,IAAM,UAAU,wBAAhB,MAAM,UAAW,SAAQ,aAAM;IAQ3B,OAAO,CAAU;IAMjB,OAAO,CAAU;IAMjB,OAAO,CAAU;IAMjB,cAAc,CAAW;CACnC,CAAA;AAnBU;IAPR,IAAA,eAAQ,EAAC,cAAc,EAAE,IAAI,+BAAiB,EAAE,EAAE;QACjD,YAAY,EAAE,eAAe;QAC7B,WAAW,EAAE,IAAA,aAAI,EAAA;;;KAGhB;KACF,CAAC;;2CACwB;AAMjB;IAJR,IAAA,eAAQ,EAAC,iCAAiC,EAAE,IAAI,gBAAS,EAAE,EAAE;QAC5D,YAAY,EAAE,8CAAkC;QAChD,WAAW,EAAE,iCAAiC;KAC/C,CAAC;;2CACwB;AAMjB;IAJR,IAAA,eAAQ,EAAC,8BAA8B,EAAE,IAAI,gBAAS,EAAE,EAAE;QACzD,YAAY,EAAE,2CAA+B;QAC7C,WAAW,EAAE,8BAA8B;KAC5C,CAAC;;2CACwB;AAMjB;IAJR,IAAA,eAAQ,EAAC,sBAAsB,EAAE,IAAI,iBAAU,EAAE,EAAE;QAClD,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,mCAAmC;KACjD,CAAC;;kDACgC;qBA1BvB,UAAU;IAHtB,IAAA,oBAAa,EAAC;QACb,IAAI,EAAE,CAAC,gBAAS,CAAC,cAAc,EAAE,gBAAS,CAAC,SAAS,EAAE,gBAAS,CAAC,UAAU,CAAC;KAC5E,CAAC;GACW,UAAU,CA2BtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/grpc.server",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Grpc transport for platform, clients and common grpc stuff",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -28,5 +28,5 @@
     "nice-grpc-opentelemetry": "^0.1.3",
     "rxjs": "^7.0.0"
   },
-  "gitHead": "32a88f5cc5a2c606bbad44d3ff8d22a4334acccc"
+  "gitHead": "2ea4aa82c26a18c1211054ea01652d40af0a82f3"
 }

package/src/grpc-logger.interceptor.ts

@@ -8,13 +8,21 @@ import { ILogger } from '@rsdk/logging';
 import type { Observable } from 'rxjs';
 import { catchError, tap, throwError } from 'rxjs';
 
+import { GRPCConfig } from './grpc.config';
+
 export class GrpcLoggerInterceptor implements NestInterceptor {
-  constructor(@InjectLogger(GrpcLoggerInterceptor) private logger: ILogger) {}
+  constructor(
+    @InjectLogger(GrpcLoggerInterceptor) private logger: ILogger,
+    private grpcConfig: GRPCConfig,
+  ) {}
 
   intercept(
     context: ExecutionContext,
     next: CallHandler<any>,
   ): Observable<any> | Promise<Observable<any>> {
+    if (!this.grpcConfig.requestLogging) {
+      return next.handle();
+    }
     const isRpc = context.getType() === 'rpc';
     if (!isRpc) {
       return next.handle();
@@ -22,7 +30,7 @@ export class GrpcLoggerInterceptor implements NestInterceptor {
 
     const rpc = context.switchToRpc();
 
-    const now = Date.now();
+    const startDate = Date.now();
     const rpcContext = rpc.getContext();
     const serializedCtx = rpcContext?.toJSON?.() ?? rpcContext;
     const requestForLog = {
@@ -30,28 +38,35 @@ export class GrpcLoggerInterceptor implements NestInterceptor {
       ctx: serializedCtx,
     };
 
-    this.logger.debug('received rpc request', {
+    this.logger.trace('received rpc request', {
       request: requestForLog,
-      timestamp: now,
+      timestamp: startDate,
     });
 
     return next.handle().pipe(
-      catchError((err) => {
-        this.logger.debug('handled rpc request with error', {
+      catchError((error) => {
+        const endDate = Date.now();
+
+        this.logger.trace('handled rpc request with error', {
           request: requestForLog,
-          start: now,
-          end: Date.now() - now,
-          err,
+          startDate,
+          endDate,
+          duration: endDate - startDate,
+          error,
         });
-        return throwError(() => err);
+        return throwError(() => error);
       }),
-      tap(() =>
-        this.logger.debug('handled rpc request', {
+      tap((response) => {
+        const endDate = Date.now();
+
+        this.logger.trace('handled rpc request', {
           request: requestForLog,
-          start: now,
-          end: Date.now() - now,
-        }),
-      ),
+          startDate,
+          endDate,
+          duration: endDate - startDate,
+          response,
+        });
+      }),
     );
   }
 }

package/src/grpc.config.ts

@@ -4,6 +4,7 @@ import {
 } from '@grpc/grpc-js/build/src/constants';
 import { text } from '@rsdk/common';
 import {
+  BoolParser,
   Config,
   ConfigSection,
   ConfigTag,
@@ -36,4 +37,10 @@ export class GRPCConfig extends Config {
     description: 'Max gRPC message size (send)',
   })
   readonly maxSend!: number;
+
+  @Property('GRPC_REQUEST_LOGGING', new BoolParser(), {
+    defaultValue: false,
+    description: 'Enable trace logging all requests',
+  })
+  readonly requestLogging!: boolean;
 }