From 1100e6ed4d2ea8525358f0995cfdae174c0a6ef4 Mon Sep 17 00:00:00 2001
From: hashjang <hash@geek.com>
Date: Thu, 15 May 2025 21:05:43 +0800
Subject: [PATCH] feat: add debug log for request and response (#19781)

---
 api/extensions/ext_logging.py | 37 +++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/api/extensions/ext_logging.py b/api/extensions/ext_logging.py
index 79d49aba5e..4a2361b326 100644
--- a/api/extensions/ext_logging.py
+++ b/api/extensions/ext_logging.py
@@ -1,3 +1,4 @@
+import json
 import logging
 import os
 import sys
@@ -60,6 +61,42 @@ def init_app(app: DifyApp):
             if handler.formatter:
                 handler.formatter.converter = time_converter
 
+    # for debugging purposes, log the request context
+    @app.before_request
+    def log_request():
+        # only log if DEBUG is enabled
+        if logging.getLogger().isEnabledFor(logging.DEBUG):
+            content_type = flask.request.content_type
+            # only log body if the request is JSON
+            if flask.request.data and 'application/json' in content_type.lower():
+                try:
+                    json_data = json.loads(flask.request.data)
+                    formatted_json = json.dumps(json_data, ensure_ascii=False, indent=2)
+                    logging.debug(f"Received Request {flask.request.method} -> {flask.request.path}, "
+                                  f"Request Body:\n{formatted_json}")
+                except Exception:
+                    logging.exception("Failed to parse JSON request")
+            else:
+                logging.debug(f"Received Request {flask.request.method} -> {flask.request.path}")
+
+    # for debugging purposes, log the response
+    @app.after_request
+    def log_response(response):
+        # only log if DEBUG is enabled
+        if logging.getLogger().isEnabledFor(logging.DEBUG):
+            # only log body if the response is JSON
+            if response.content_type and 'application/json' in response.content_type.lower():
+                try:
+                    response_data = response.get_data(as_text=True)
+                    json_data = json.loads(response_data)
+                    formatted_json = json.dumps(json_data, ensure_ascii=False, indent=2)
+                    logging.debug(f"Response {response.status} {response.content_type}, "
+                                  f"Response Body:\n{formatted_json}")
+                except Exception:
+                    logging.exception("Failed to parse JSON response")
+            else:
+                logging.debug(f"Response {response.status} {response.content_type}")
+            return response
 
 def get_request_id():
     if getattr(flask.g, "request_id", None):