@lark-apaas/nestjs-logger 0.1.0-alpha.2 → 0.1.0-alpha.4

package/dist/index.d.cts

@@ -32,6 +32,14 @@ declare abstract class BasePinoLogger implements LoggerService {
     debug?(message: unknown, ...optionalParams: unknown[]): void;
     verbose?(message: unknown, ...optionalParams: unknown[]): void;
     fatal?(message: unknown, ...optionalParams: unknown[]): void;
+    /**
+     * 记录结构化日志，将 meta 对象合并到日志字段中
+     * @param level 日志级别
+     * @param message 消息文本
+     * @param meta 要合并的元数据对象
+     * @param context 上下文标识
+     */
+    logStructured(level: LogLevel, message: string, meta: Record<string, unknown>, context?: string): void;
     protected write(level: LogLevel, message: unknown, optionalParams: unknown[], treatStack?: boolean): void;
     private extractOptionalParams;
     private buildMessagePayload;
@@ -40,6 +48,8 @@ declare abstract class BasePinoLogger implements LoggerService {
 declare class AppLogger extends BasePinoLogger {
     constructor(logger: Logger, requestContext: RequestContextService);
 }
+declare class PinoLoggerService extends BasePinoLogger {
+}
 
 declare class LoggerModule {
 }
@@ -59,4 +69,4 @@ declare class LoggerContextMiddleware implements NestMiddleware {
 
 declare const TRACE_LOGGER: unique symbol;
 
-export { AppLogger, LoggerContextMiddleware, LoggerModule, TRACE_LOGGER };
+export { AppLogger, LoggerContextMiddleware, LoggerModule, PinoLoggerService, TRACE_LOGGER };

package/dist/index.d.ts

@@ -32,6 +32,14 @@ declare abstract class BasePinoLogger implements LoggerService {
     debug?(message: unknown, ...optionalParams: unknown[]): void;
     verbose?(message: unknown, ...optionalParams: unknown[]): void;
     fatal?(message: unknown, ...optionalParams: unknown[]): void;
+    /**
+     * 记录结构化日志，将 meta 对象合并到日志字段中
+     * @param level 日志级别
+     * @param message 消息文本
+     * @param meta 要合并的元数据对象
+     * @param context 上下文标识
+     */
+    logStructured(level: LogLevel, message: string, meta: Record<string, unknown>, context?: string): void;
     protected write(level: LogLevel, message: unknown, optionalParams: unknown[], treatStack?: boolean): void;
     private extractOptionalParams;
     private buildMessagePayload;
@@ -40,6 +48,8 @@ declare abstract class BasePinoLogger implements LoggerService {
 declare class AppLogger extends BasePinoLogger {
     constructor(logger: Logger, requestContext: RequestContextService);
 }
+declare class PinoLoggerService extends BasePinoLogger {
+}
 
 declare class LoggerModule {
 }
@@ -59,4 +69,4 @@ declare class LoggerContextMiddleware implements NestMiddleware {
 
 declare const TRACE_LOGGER: unique symbol;
 
-export { AppLogger, LoggerContextMiddleware, LoggerModule, TRACE_LOGGER };
+export { AppLogger, LoggerContextMiddleware, LoggerModule, PinoLoggerService, TRACE_LOGGER };

package/dist/index.js

@@ -14511,6 +14511,36 @@ var BasePinoLogger = class _BasePinoLogger {
   fatal(message, ...optionalParams) {
     this.write("fatal", message, optionalParams, true);
   }
+  /**
+  * 记录结构化日志，将 meta 对象合并到日志字段中
+  * @param level 日志级别
+  * @param message 消息文本
+  * @param meta 要合并的元数据对象
+  * @param context 上下文标识
+  */
+  logStructured(level, message, meta, context) {
+    if (!this.levelState.isEnabled(level)) {
+      return;
+    }
+    const requestState = this.contextStore.getContext();
+    const traceId = requestState?.requestId ?? null;
+    const payload = {
+      trace_id: traceId,
+      path: requestState?.path,
+      method: requestState?.method,
+      user_id: requestState?.userId ?? null,
+      app_id: requestState?.appId ?? null,
+      tenant_id: requestState?.tenantId ?? null,
+      pid: process.pid,
+      ...sanitizeValue(meta)
+    };
+    if (context) {
+      payload.context = context;
+    }
+    const pinoLevel = mapLogLevelToPino(level);
+    const sanitizedPayload = sanitizeValue(payload);
+    this.logger[pinoLevel](sanitizedPayload, message);
+  }
   write(level, message, optionalParams, treatStack = false) {
     if (!this.levelState.isEnabled(level)) {
       return;
@@ -14669,7 +14699,7 @@ function sanitizeValue(value) {
 __name(sanitizeValue, "sanitizeValue");
 
 // src/module.ts
-var import_config2 = __toESM(require_config2(), 1);
+var import_config3 = __toESM(require_config2(), 1);
 import { Global, Module } from "@nestjs/common";
 import { APP_INTERCEPTOR } from "@nestjs/core";
 
@@ -14693,15 +14723,22 @@ function normalizeLevel(level) {
 __name(normalizeLevel, "normalizeLevel");
 var logger_config_default = (0, import_config.registerAs)("logger", () => {
   const level = normalizeLevel(process.env.LOGGER_LEVEL || (process.env.NODE_ENV === "production" ? "info" : "debug"));
+  const maxBodyLengthEnv = process.env.LOG_MAX_BODY_LENGTH;
+  const maxBodyLength = maxBodyLengthEnv ? Number(maxBodyLengthEnv) : null;
   return {
     level,
-    logDir: process.env.LOG_DIR || "logs"
+    logDir: process.env.LOG_DIR || "logs",
+    logRequestBody: process.env.LOG_REQUEST_BODY === "true",
+    logResponseBody: process.env.LOG_RESPONSE_BODY === "true",
+    maxBodyLength,
+    sensitiveFields: (process.env.LOG_SENSITIVE_FIELDS || "password,token,secret,authorization,cookie,apiKey,accessToken,refreshToken").split(",").map((f) => f.trim())
   };
 });
 
 // src/interceptor/logging.interceptor.ts
+var import_config2 = __toESM(require_config2(), 1);
 var import_operators = __toESM(require_operators(), 1);
-import { Inject as Inject2, Injectable as Injectable3, LoggerService } from "@nestjs/common";
+import { Inject as Inject2, Injectable as Injectable3 } from "@nestjs/common";
 function _ts_decorate3(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -14725,9 +14762,13 @@ var LoggingInterceptor = class {
   }
   traceLogger;
   requestContext;
-  constructor(traceLogger, requestContext) {
+  appLogger;
+  config;
+  constructor(traceLogger, requestContext, appLogger, config) {
     this.traceLogger = traceLogger;
     this.requestContext = requestContext;
+    this.appLogger = appLogger;
+    this.config = config;
   }
   intercept(context, next) {
     if (context.getType() !== "http") {
@@ -14746,7 +14787,6 @@ var LoggingInterceptor = class {
     const baseMeta = {
       method,
       path: url,
-      requestId: req.requestId ?? req.id,
       trace_id: req.requestId ?? req.id,
       user_id: req.userContext?.userId ?? null,
       tenant_id: req.userContext?.tenantId ?? null,
@@ -14754,39 +14794,141 @@ var LoggingInterceptor = class {
       ip: req.ip ?? null,
       pid: process.pid
     };
-    this.traceLogger.log("HTTP request started", baseMeta, "HTTP");
-    return next.handle().pipe((0, import_operators.tap)(() => {
+    this.appLogger.logStructured("log", "HTTP request started", baseMeta, "HTTPTraceInterceptor");
+    const requestMeta = {
+      ...baseMeta
+    };
+    if (this.config.logRequestBody && req.body) {
+      requestMeta["request_body"] = this.sanitizeAndTruncate(req.body);
+    }
+    if (this.config.logRequestBody && Object.keys(req.query || {}).length > 0) {
+      requestMeta["query_params"] = this.sanitizeAndTruncate(req.query);
+    }
+    this.traceLogger.logStructured("verbose", "HTTP request started", requestMeta, "HTTPTraceInterceptor");
+    return next.handle().pipe((0, import_operators.tap)((responseData) => {
       const durationMs = Date.now() - startedAt;
       const statusCode = res.statusCode;
-      this.traceLogger.log("HTTP request completed", {
+      this.appLogger.logStructured("log", "HTTP request completed", {
+        ...baseMeta,
+        status_code: statusCode,
+        duration_ms: durationMs
+      }, "HTTPTraceInterceptor");
+      const responseMeta = {
         ...baseMeta,
-        statusCode,
-        durationMs
-      }, "HTTP");
+        status_code: statusCode,
+        duration_ms: durationMs
+      };
+      if (this.config.logResponseBody && responseData !== void 0) {
+        const contentType = res.getHeader("content-type");
+        const isJsonResponse = this.isJsonContentType(contentType);
+        if (isJsonResponse) {
+          responseMeta["response_body"] = this.sanitizeAndTruncate(responseData);
+        }
+      }
+      this.traceLogger.logStructured("verbose", "HTTP request completed", responseMeta, "HTTPTraceInterceptor");
     }), (0, import_operators.catchError)((error) => {
       const durationMs = Date.now() - startedAt;
       const statusCode = res.statusCode >= 400 ? res.statusCode : 500;
+      const linkMeta = {
+        ...baseMeta,
+        status_code: statusCode,
+        duration_ms: durationMs
+      };
+      if (error instanceof Error) {
+        linkMeta["error_message"] = error.message;
+      }
+      this.appLogger.logStructured("log", "HTTP request failed", linkMeta, "HTTPTraceInterceptor");
       const meta = {
         ...baseMeta,
-        statusCode,
-        durationMs
+        status_code: statusCode,
+        duration_ms: durationMs
       };
       if (error instanceof Error) {
-        this.traceLogger.error(error, meta, "HTTP");
+        meta["error"] = {
+          message: error.message,
+          stack: error.stack
+        };
       } else {
-        this.traceLogger.error("Unknown error thrown", meta, "HTTP");
+        meta["error"] = String(error);
       }
+      this.traceLogger.logStructured("verbose", "HTTP request failed", meta, "HTTPTraceInterceptor");
       throw error;
     }));
   }
+  /**
+  * 对数据进行脱敏和截断处理
+  */
+  sanitizeAndTruncate(data) {
+    try {
+      const sanitized = this.maskSensitiveFields(data);
+      if (this.config.maxBodyLength === null) {
+        return sanitized;
+      }
+      const jsonStr = JSON.stringify(sanitized);
+      if (jsonStr.length > this.config.maxBodyLength) {
+        return {
+          _truncated: true,
+          _originalLength: jsonStr.length,
+          _data: jsonStr.substring(0, this.config.maxBodyLength) + "..."
+        };
+      }
+      return sanitized;
+    } catch (error) {
+      return {
+        _error: "Failed to serialize data",
+        _message: error instanceof Error ? error.message : String(error)
+      };
+    }
+  }
+  /**
+  * 判断是否是 JSON 响应类型
+  */
+  isJsonContentType(contentType) {
+    if (typeof contentType !== "string") {
+      return false;
+    }
+    const contentTypeLower = contentType.toLowerCase();
+    return contentTypeLower.includes("application/json");
+  }
+  /**
+  * 脱敏敏感字段
+  */
+  maskSensitiveFields(data) {
+    if (data === null || data === void 0) {
+      return data;
+    }
+    if (Array.isArray(data)) {
+      return data.map((item) => this.maskSensitiveFields(item));
+    }
+    if (typeof data === "object") {
+      const result = {};
+      for (const [key, value] of Object.entries(data)) {
+        const lowerKey = key.toLowerCase();
+        const isSensitive = this.config.sensitiveFields.some((field) => lowerKey.includes(field.toLowerCase()));
+        if (isSensitive) {
+          result[key] = "***MASKED***";
+        } else if (typeof value === "object" && value !== null) {
+          result[key] = this.maskSensitiveFields(value);
+        } else {
+          result[key] = value;
+        }
+      }
+      return result;
+    }
+    return data;
+  }
 };
 LoggingInterceptor = _ts_decorate3([
   Injectable3(),
   _ts_param2(0, Inject2(TRACE_LOGGER)),
+  _ts_param2(2, Inject2(AppLogger)),
+  _ts_param2(3, Inject2(logger_config_default.KEY)),
   _ts_metadata2("design:type", Function),
   _ts_metadata2("design:paramtypes", [
-    typeof LoggerService === "undefined" ? Object : LoggerService,
-    typeof RequestContextService === "undefined" ? Object : RequestContextService
+    typeof PinoLoggerService === "undefined" ? Object : PinoLoggerService,
+    typeof RequestContextService === "undefined" ? Object : RequestContextService,
+    typeof AppLogger === "undefined" ? Object : AppLogger,
+    typeof import_config2.ConfigType === "undefined" ? Object : import_config2.ConfigType
   ])
 ], LoggingInterceptor);
 
@@ -14904,7 +15046,7 @@ LoggerModule = _ts_decorate5([
   Global(),
   Module({
     imports: [
-      import_config2.ConfigModule.forFeature(logger_config_default)
+      import_config3.ConfigModule.forFeature(logger_config_default)
     ],
     providers: [
       RequestContextService,
@@ -14951,6 +15093,7 @@ export {
   AppLogger,
   LoggerContextMiddleware,
   LoggerModule,
+  PinoLoggerService,
   TRACE_LOGGER
 };
 //# sourceMappingURL=index.js.map