refactor(portaswitch): improve logging efficiency with message truncation and remove redundant debug logs

Author: yakimenko73

app/bss/adapters/portaswitch/api/account.py

@@ -1,12 +1,12 @@
-import logging
 from datetime import datetime
 from typing import Final, List, Union, Iterator
 
 import requests
+from jose import jwt
+
 from bss.adapters.portaswitch.config import PortaSwitchSettings
 from bss.adapters.portaswitch.types import PortaSwitchMailboxMessageFlag, PortaSwitchMailboxMessageFlagAction
 from bss.http_api import HTTPAPIConnector, AuthSessionData
-from jose import jwt
 
 DEFAULT_CHUNK_SIZE: Final[int] = 8192
 
@@ -40,7 +40,6 @@ def __send_request(
             :response (dict): The API method execution result.
 
         """
-        logging.debug(f"Sending Account.API request: {module}/{method}/{params}")
 
         headers = None
         if access_token:
@@ -54,7 +53,6 @@ def __send_request(
             stream=stream,
         )
 
-        logging.debug(f"Processing the Account.API result: {module}/{method}/{params}: \n {result}")
         return result
 
     def add_auth_info(self, url: str, request_params: dict, auth_session: AuthSessionData) -> dict:
@@ -284,7 +282,8 @@ def get_phone_directory_list(self, access_token: str, page: int, items_per_page:
             },
             access_token=access_token)
 
-    def get_phone_directory_info(self, access_token: str, i_ua_config_directory: str, page: int, items_per_page: int) -> dict:
+    def get_phone_directory_info(self, access_token: str, i_ua_config_directory: str, page: int,
+                                 items_per_page: int) -> dict:
         """Return the phone directory info of the account.
 
         Args:

app/bss/adapters/portaswitch/api/admin.py

@@ -183,8 +183,6 @@ def _send_request(self, module: str, method: str, params: dict, turn_off_login:
             :response (object): The API method execution result.
 
         """
-        logging.debug(f"Sending Admin.API request: {module}/{method}/{params}")
-
         try:
             result = self.send_rest_request(
                 method="POST",
@@ -212,5 +210,4 @@ def _send_request(self, module: str, method: str, params: dict, turn_off_login:
             else:
                 raise error
 
-        logging.debug(f"Processing the Admin.API result: {module}/{method}/{params}: \n {result}")
         return result

app/bss/http_api.py

@@ -1,19 +1,15 @@
 import logging
+import threading
+import uuid
 from abc import ABC, abstractmethod
-from typing import Optional
-
-from pydantic import BaseModel, Field
 from datetime import datetime, timedelta
+from typing import Optional
 
 import requests
+from pydantic import BaseModel, Field
 
 from report_error import raise_webtrit_error
-import threading
-from request_trace import get_request_id
-import uuid
-
-
-# from bss.types import SignupExtAPIErrorCode as ExtAPIErrorCode
+from request_trace import get_request_id, truncate_log_message
 
 
 class APIUser(BaseModel):
@@ -124,7 +120,7 @@ def send_rest_request(self,
         try:
             logging.debug(f"Sending {method} request to {url} with parameters {params_final}")
             response = requests.request(method, url, **params_final)
-            clean_text = response.text.replace("\n", " ")
+            clean_text = truncate_log_message(response.text.replace("\n", " "))
             logging.debug(f"Received {response.status_code} {clean_text}")
             response.raise_for_status()
             return self.decode_response(response)
@@ -256,8 +252,8 @@ def send_rest_request(self,
                 # we do not have an access token, need to log in first
                 if hasattr(user, 'password') and user.password is None:
                     raise_webtrit_error(401,
-                                    error_message="Authentication session is closed, need to re-login",
-                                    extra_error_code="access_token_expired")
+                                        error_message="Authentication session is closed, need to re-login",
+                                        extra_error_code="access_token_expired")
 
                 auth_session = self.login(user)
                 self.store_auth_session(auth_session, user)

app/request_trace.py

@@ -12,9 +12,21 @@
 from starlette.responses import StreamingResponse
 import traceback
 
+MAX_LOG_MESSAGE_LENGTH = int(os.getenv("LOG_MAX_MESSAGE_LENGTH", "1000"))
+
 # Add context variable for request ID
 current_request_id = contextvars.ContextVar('current_request_id', default="STARTUP")
 
+
+
+def truncate_log_message(message: str, max_length: int = MAX_LOG_MESSAGE_LENGTH) -> str:
+    """Truncate log message to avoid logging excessively large payloads."""
+    if message is None:
+        return ""
+    if len(message) <= max_length:
+        return message
+    return f"{message[:max_length]}... [truncated {len(message) - max_length} chars]"
+
 class AddRequestID(logging.Filter):
     """Logging filter that adds request_id to log records"""
     def filter(self, record):
@@ -78,7 +90,7 @@ def log_formatted_json(label: str, text):
     if len(text) == 0:
         logging.info(f"{label}: Empty")
         return
-    logging.info(f"{label}: {text}")
+    logging.info(f"{label}: {truncate_log_message(text)}")
     return
 
 def log_info(req_body, res_body):