@lark-apaas/nestjs-logger 1.0.1-alpha.0 → 1.0.1-alpha.1

package/README.md

@@ -99,6 +99,14 @@ HTTP 请求追踪日志使用 **`verbose` 级别**（对应 Pino 的 `trace` 级
 - **需要显式启用**：要查看 HTTP 请求追踪日志，需要将 `LOGGER_LEVEL` 设置为 `verbose`
 - **细粒度控制**：可以通过日志级别控制是否打印请求追踪，而无需修改 `LOG_REQUEST_BODY` 和 `LOG_RESPONSE_BODY` 配置
 
+### 响应体记录规则
+
+**只针对 JSON 响应记录 body**：
+- 自动检测 `Content-Type` 是否包含 `application/json`
+- 只有 JSON 响应才会记录 `response_body` 字段
+- 文件下载、HTML 页面等非 JSON 响应不会记录 body，避免日志污染
+- 这样可以显著减少日志体积，同时保持日志的可读性
+
 ### 启用方式
 
 通过环境变量启用：
@@ -121,7 +129,11 @@ LOG_RESPONSE_BODY=true
 
 2. **默认不限制长度**：如果不设置 `LOG_MAX_BODY_LENGTH` 环境变量，日志体不会被截断。建议在生产环境设置合理的限制值。
 
-3. **响应数据处理**：日志库会尝试序列化所有响应数据，对于无法序列化的数据（如 Buffer、Stream）会返回类型信息。
+3. **响应体过滤**：
+   - 只记录 JSON 响应的 body（检测 Content-Type）
+   - 文件下载、HTML、图片等非 JSON 响应不会记录 body
+   - 避免记录无法序列化的数据（如 Buffer、Stream）
+   - 显著减少日志体积，提高日志可读性
 
 ### 日志输出示例
 
@@ -250,6 +262,7 @@ NestJS LoggerService 级别到 Pino 级别的映射：
 
 3. **实现原理**：
    - **拦截响应方法**：在 Interceptor 中拦截 `res.json()` 和 `res.send()`，存储响应体到 `res.__finalResponseBody`
+   - **类型检测**：通过 `Content-Type` header 判断是否为 JSON 响应，只记录 JSON 类型的 body
    - **延迟记录**：不在 Interceptor 的 `tap()` 或 `catchError()` 中记录日志，而是在 `finish` 事件中统一记录
    - **完整信息**：此时可以获取 Exception Filter 处理后的最终状态码和响应体，确保日志准确性
 

package/dist/index.cjs

@@ -14890,16 +14890,27 @@ var LoggingInterceptor = class {
         duration_ms: durationMs
       };
       const finalResponseBody = res.__finalResponseBody;
-      if (this.config.logResponseBody && finalResponseBody !== void 0) {
+      const contentType = res.getHeader("content-type");
+      const isJsonResponse = typeof contentType === "string" && contentType.includes("application/json");
+      if (this.config.logResponseBody && finalResponseBody !== void 0 && isJsonResponse) {
         responseMeta["response_body"] = this.sanitizeAndTruncate(finalResponseBody);
       }
       const isError = statusCode >= 400;
       const appLog = this.appLogger[isError ? "error" : "log"].bind(this.appLogger);
       const traceLevel = isError ? "error" : "verbose";
+      const shouldLogBody = this.config.logResponseBody && isJsonResponse && finalResponseBody !== void 0;
       if (isError) {
-        appLog("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody ?? {});
+        if (shouldLogBody) {
+          appLog("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody);
+        } else {
+          appLog("HTTP request failed\n url=%s \n status_code=%d \n duration_ms=%d", req.url, statusCode, durationMs);
+        }
       } else {
-        appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody ?? {});
+        if (shouldLogBody) {
+          appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d \n response_body=%o", req.url, statusCode, durationMs, finalResponseBody);
+        } else {
+          appLog("HTTP request completed\n url=%s \n status_code=%d \n duration_ms=%d", req.url, statusCode, durationMs);
+        }
       }
       this.traceLogger.logStructured(traceLevel, isError ? "HTTP request failed" : "HTTP request completed", responseMeta, "HTTPTraceInterceptor");
     });