Add logging to v2 APIs

We have added middleware logging for request/response to API calls via v2 APIs. The logging
information includes the IP address, user (if authenticated), request details, and response details.
Enabling or disabling this logging can be configured through setting.ENABLE_API_LOGGING.

Author: hoangpn

promgen/middleware.py

@@ -17,7 +17,9 @@
 caching system to set a key and then triggering the actual event from middleware
 """
 
+import json
 import logging
+import uuid
 from http import HTTPStatus
 from threading import local
 
@@ -53,8 +55,53 @@ def __call__(self, request):
         if request.user.is_authenticated:
             _user.value = request.user
 
+        # Log all requests to our v2 API endpoints
+        if settings.ENABLE_API_LOGGING and request.path.startswith("/rest/v2/"):
+            try:
+                # Generate a trace ID for each request
+                trace_id = str(uuid.uuid4())
+                request.trace_id = trace_id
+                # Log the IP address of the request
+                ip_address = request.META.get("REMOTE_ADDR")
+                logger.info(f"[Trace ID: {trace_id}] IP Address: {ip_address}")
+                # Log the user if authenticated
+                if request.user.is_authenticated:
+                    logger.info(f"[Trace ID: {trace_id}] User: {request.user.username}")
+                # Log the request details
+                logger.info(
+                    f"[Trace ID: {request.trace_id}] Request: {request.method} {request.get_full_path()}"
+                )
+                if request.body and request.headers["Content-Type"] == "application/json":
+                    logger.info(
+                        f"[Trace ID: {request.trace_id}] Request body: {json.loads(request.body)}"
+                    )
+            except Exception as e:
+                logger.exception(
+                    f"[Trace ID: {request.trace_id}] An error occurred when parsing request: {str(e)}"
+                )
+
         response = self.get_response(request)
 
+        # Log all responses to our v2 API endpoints
+        if settings.ENABLE_API_LOGGING and request.path.startswith("/rest/v2/"):
+            try:
+                # Log the response details
+                logger.info(
+                    f"[Trace ID: {request.trace_id}] Response status: {response.status_code}"
+                )
+                if (
+                    hasattr(response, "content")
+                    and response.headers["Content-Type"] == "application/json"
+                    and response.content
+                ):
+                    logger.info(
+                        f"[Trace ID: {request.trace_id}] Response body: {json.loads(response.content)}"
+                    )
+            except Exception as e:
+                logger.exception(
+                    f"[Trace ID: {request.trace_id}] An error occurred when parsing response: {str(e)}"
+                )
+
         triggers = {
             "Config": trigger_write_config.send,
             "Rules": trigger_write_rules.send,

promgen/settings.py

@@ -239,3 +239,5 @@
     "DESCRIPTION": "Non-GET APIs require authentication. "
     "Please login Promgen and access the Profile page to get a Token.",
 }
+
+ENABLE_API_LOGGING = env.bool("ENABLE_API_LOGGING", default=False)