@lark-apaas/nestjs-logger 0.1.0-alpha.6 → 0.1.0-alpha.7

package/README.md

@@ -1,16 +1,16 @@
 # NestJS Logger
 
-基于 Pino 的高性能 NestJS 日志库，支持请求追踪、结构化日志和敏感信息脱敏。
+基于 Pino 的高性能 NestJS 日志库，支持请求追踪和结构化日志。
 
 ## 功能特性
 
 - 基于 Pino 的高性能日志记录
-- 自动 HTTP 请求追踪
+- 自动 HTTP 请求追踪（双层日志：info 链路日志 + verbose 详细日志）
 - 请求和响应体日志记录（可配置）
-- 敏感字段自动脱敏
 - 支持多日志级别
 - 独立的 trace 日志文件
 - 请求上下文传递
+- 日志体长度截断
 
 ## 安装
 
@@ -74,7 +74,6 @@ NODE_ENV=production
 LOG_REQUEST_BODY=true
 
 # 启用响应体日志（默认：false）
-# 注意：仅记录 Content-Type 为 JSON 的响应
 LOG_RESPONSE_BODY=true
 
 # 注意：即使启用了请求/响应体日志，也需要将日志级别设置为 verbose 才能实际输出
@@ -84,9 +83,6 @@ LOGGER_LEVEL=verbose
 # 日志体最大长度，超过会截断（默认：不限制）
 # 不设置此环境变量时，不会进行截断
 LOG_MAX_BODY_LENGTH=10000
-
-# 敏感字段配置（逗号分隔，默认包含常见敏感字段）
-LOG_SENSITIVE_FIELDS=password,token,secret,authorization,cookie,apiKey,accessToken,refreshToken
 ```
 
 ## 请求/响应体日志
@@ -115,108 +111,85 @@ LOG_RESPONSE_BODY=true
 
 ### 重要说明
 
-1. **仅记录 JSON 响应**：响应体日志只会记录 Content-Type 为 JSON 格式的响应（如 `application/json`、`application/vnd.api+json` 等），其他类型（如文件下载、HTML、图片等）不会被记录。
+1. **双层日志机制**：
+   - **info 级别**：始终记录基础链路日志（不含 body），用于生产环境请求追踪
+   - **verbose 级别**：记录详细追踪日志（包含 body），用于开发调试
 
 2. **默认不限制长度**：如果不设置 `LOG_MAX_BODY_LENGTH` 环境变量，日志体不会被截断。建议在生产环境设置合理的限制值。
 
-3. **自动脱敏**：所有敏感字段会自动被替换为 `***MASKED***`。
+3. **响应数据处理**：日志库会尝试序列化所有响应数据，对于无法序列化的数据（如 Buffer、Stream）会返回类型信息。
 
 ### 日志输出示例
 
-#### 请求日志（包含请求体）
+#### Info 级别（链路日志）
 
 ```json
 {
-  "level": "info",
+  "level": "INFO",
   "time": 1234567890,
   "msg": "HTTP request started",
-  "method": "POST",
+  "method": "GET",
   "path": "/api/users",
   "trace_id": "req-123-456",
   "user_id": "user-001",
-  "requestBody": {
-    "username": "john_doe",
-    "email": "john@example.com",
-    "password": "***MASKED***"
-  },
-  "queryParams": {
-    "filter": "active"
-  }
+  "tenant_id": 24020896,
+  "app_id": "",
+  "context": "HTTPTraceInterceptor"
 }
 ```
 
-#### 响应日志（包含响应体）
-
 ```json
 {
-  "level": "info",
+  "level": "INFO",
   "time": 1234567890,
   "msg": "HTTP request completed",
-  "method": "POST",
+  "method": "GET",
   "path": "/api/users",
   "trace_id": "req-123-456",
-  "statusCode": 201,
-  "durationMs": 125,
-  "responseBody": {
-    "id": "user-123",
-    "username": "john_doe",
-    "email": "john@example.com",
-    "accessToken": "***MASKED***"
-  }
+  "status_code": 200,
+  "duration_ms": 125,
+  "context": "HTTPTraceInterceptor"
 }
 ```
 
-## 敏感字段脱敏
-
-### 默认脱敏字段
-
-以下字段会自动脱敏（不区分大小写，支持部分匹配）：
-
-- password
-- token
-- secret
-- authorization
-- cookie
-- apiKey
-- accessToken
-- refreshToken
-
-### 自定义敏感字段
-
-通过环境变量配置：
-
-```bash
-LOG_SENSITIVE_FIELDS=password,token,secret,myCustomSecret,privateKey
-```
-
-### 脱敏规则
-
-- 字段匹配不区分大小写
-- 支持部分匹配（例如：`accessToken` 会匹配 `token`）
-- 敏感字段值会被替换为 `***MASKED***`
-- 嵌套对象中的敏感字段也会被脱敏
-
-### 示例
+#### Verbose 级别（详细追踪日志）
 
-```typescript
-// 原始数据
+```json
 {
-  username: "john",
-  password: "secret123",
-  userToken: "abc123",
-  nested: {
-    apiKey: "key123"
-  }
+  "level": "TRACE",
+  "time": 1234567890,
+  "msg": "HTTP request started",
+  "method": "POST",
+  "path": "/api/users",
+  "trace_id": "req-123-456",
+  "request_body": {
+    "username": "john_doe",
+    "email": "john@example.com",
+    "password": "secret123"
+  },
+  "query_params": {
+    "filter": "active"
+  },
+  "context": "HTTPTraceInterceptor"
 }
+```
 
-// 脱敏后
+```json
 {
-  username: "john",
-  password: "***MASKED***",
-  userToken: "***MASKED***",  // 匹配 'token'
-  nested: {
-    apiKey: "***MASKED***"
-  }
+  "level": "TRACE",
+  "time": 1234567890,
+  "msg": "HTTP request completed",
+  "method": "POST",
+  "path": "/api/users",
+  "trace_id": "req-123-456",
+  "status_code": 201,
+  "duration_ms": 125,
+  "response_body": {
+    "id": "user-123",
+    "username": "john_doe",
+    "email": "john@example.com"
+  },
+  "context": "HTTPTraceInterceptor"
 }
 ```
 
@@ -226,7 +199,7 @@ LOG_SENSITIVE_FIELDS=password,token,secret,myCustomSecret,privateKey
 
 ```json
 {
-  "responseBody": {
+  "response_body": {
     "_truncated": true,
     "_originalLength": 50000,
     "_data": "{ 前 10000 个字符... }..."
@@ -258,22 +231,21 @@ NestJS LoggerService 级别到 Pino 级别的映射：
 
 ### 安全性
 
-1. **生产环境默认不打印 HTTP 追踪日志**：由于使用 verbose 级别，生产环境（info 级别）默认不会输出
-2. **按需启用**：需要查看请求追踪时，将 LOGGER_LEVEL 设置为 verbose
-3. 确保敏感字段配置完整，覆盖所有可能的敏感数据
-4. 定期审查日志内容，确保没有遗漏的敏感信息
-5. **仅 JSON 响应会被记录**，文件下载、HTML 等其他类型不会被记录
+1. **生产环境默认不打印 HTTP 追踪日志**：由于使用 verbose 级别，生产环境（info 级别）默认不会输出详细日志
+2. **双层日志设计**：info 级别始终记录链路日志，verbose 级别记录详细信息，按需启用
+3. **按需启用**：需要查看详细追踪时，将 LOGGER_LEVEL 设置为 verbose
+4. **敏感数据处理**：日志库不提供脱敏功能，请在业务层或通过中间件处理敏感数据
 
 ### 性能
 
-1. verbose 级别会输出所有 HTTP 请求日志，可能影响性能
+1. verbose 级别会输出所有 HTTP 请求详细日志，可能影响性能
 2. 开启请求/响应体日志会增加日志体积和 I/O 开销
-3. 大对象的序列化和脱敏会影响性能
+3. 大对象的序列化会影响性能
 4. 建议在开发/测试环境使用，生产环境按需临时启用
 
 ### 存储
 
-1. 注意日志文件大小，建议配置日志轮转
+1. 日志直接写入文件，不支持自动轮转，建议通过外部工具（如 logrotate）管理日志文件
 2. verbose 级别 + 请求/响应体日志会显著增加日志量
 3. 建议设置 `LOG_MAX_BODY_LENGTH` 限制单条日志大小（默认不限制）
 

package/dist/index.cjs

@@ -14792,8 +14792,7 @@ var logger_config_default = (0, import_config.registerAs)("logger", () => {
     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 || "").split(",").map((f) => f.trim())
+    maxBodyLength
   };
 });
 
@@ -14914,15 +14913,14 @@ var LoggingInterceptor = class {
     }));
   }
   /**
-  * 对数据进行脱敏和截断处理
+  * 对数据进行截断处理
   */
   sanitizeAndTruncate(data) {
     try {
-      const sanitized = this.maskSensitiveFields(data);
       if (this.config.maxBodyLength === null) {
-        return sanitized;
+        return data;
       }
-      const jsonStr = JSON.stringify(sanitized);
+      const jsonStr = JSON.stringify(data);
       if (jsonStr.length > this.config.maxBodyLength) {
         return {
           _truncated: true,
@@ -14930,7 +14928,7 @@ var LoggingInterceptor = class {
           _data: jsonStr.substring(0, this.config.maxBodyLength) + "..."
         };
       }
-      return sanitized;
+      return data;
     } catch (error) {
       return {
         _error: "Failed to serialize data",
@@ -14939,33 +14937,6 @@ var LoggingInterceptor = class {
       };
     }
   }
-  /**
-  * 脱敏敏感字段
-  */
-  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([
   (0, import_common3.Injectable)(),