SDK新增滚动日志功能

docs/BasisModule/Trace/Debug.md

@@ -51,4 +51,36 @@ System.setProperty("APPBUILDER_LOGLFILE", "/tmp/appbuilder.log");
 ```golang
 // golang
 os.Setenv("APPBUILDER_LOGLEVEL", "/tmp/appbuilder.log")
+```
+
+## `setLogConfig`功能
+
+Appbuilder-SDK新增滚动日志功能
+
+主要参数:
+- console_show: 数据类型bool，默认值True，LOG日志是否在控制台输出
+- loglevel: 数据类型str，默认值"DEBUG"，LOG日志级别
+- file_name: 数据类型str，默认值"tmp.log"，LOG日志名称
+- when: 数据类型str，默认值"MIDNIGHT"，LOG日志滚动更新时间单位
+    - "S": 以秒为单位
+    - "M": 以分钟为单位
+    - "H": 以小时为单位
+    - "D": 以天为时间单位
+    - "MIDNIGHT": 每日凌晨更新
+- interval: 数据类型int，默认值1，LOG日志按时间滚动的参数，默认值为1，与when参数联合使用
+- max_bytes: 数据类型Optional[int]，默认值None，传入`None`或负数会自动更新为系统最大整数`sys.maxsize`，单个滚动的LOG日志文件的最大大小，例：10M即为10\*1024\*1024 即需要传入 # 以B为单位
+- total_size_limit: 数据类型Optional[int]，默认值None，传入`None`或负数会自动更新为系统最大整数`sys.maxsize`，当前目录下可储存的LOG日志文件的最大大小，例：10M即为10\*1024\*1024 # 以B为单位
+- backup_count: 数据类型Optional[int]，默认值None，传入`None`或负数会自动更新为系统最大整数`sys.maxsize`，当前目录下可储存的LOG日志文件的最大数量
+
+```python
+# python
+appbuilder.logger.setLogConfig(
+    console_show = False,
+    file_name="appbuilder.log", 
+    when="MIDNIGHT", # 每日凌晨更新 
+    interval=1,
+    max_bytes=100 * 1024 *1024, # 最大日志大小为100MB
+    total_size_limit=1024 * 1024 *1024, # 最大储存1GB的日志
+    backup_count=10, # 当前目录储存的最大LOG日志数 
+    )
 ```

python/__init__.py

@@ -202,8 +202,11 @@ def get_default_header():
 
 from appbuilder.utils.trace.tracer import AppBuilderTracer, AppbuilderInstrumentor
 
+from .utils.logger_file_headler import SizeAndTimeRotatingFileHandler
+
 __all__ = [
     "logger",
+    "SizeAndTimeRotatingFileHandler",
     "BadRequestException",
     "ForbiddenException",
     "NotFoundException",

python/tests/test_log_set_log_config.py

@@ -0,0 +1,111 @@
+# Copyright (c) 2024 Baidu, Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import time
+import logging
+import unittest
+
+
+from appbuilder import SizeAndTimeRotatingFileHandler
+from appbuilder.utils.logger_util import LoggerWithLoggerId
+
+class TestLogSetLogConfig(unittest.TestCase):
+    def test_set_log_config(self):
+        lwl=LoggerWithLoggerId(logger='test_logger',extra={'logid':'test_logid'},loglevel='INFO')
+        lwl.setLogConfig(
+            console_show = True,
+            loglevel='DEBUG',
+            file_name='test.log',
+            when='D',
+            interval=0, # 测试interval<1时，自动更新为1
+            max_bytes=None, # 测试not max_bytes or max_bytes <= 0时，自动更新为sys.maxsize
+            total_size_limit=None, # 测试not total_size_limit or total_size_limit <= 0时，自动更新为sys.maxsize
+            backup_count=None, # 测试not backup_count or backup_count <= 0时，自动更新为sys.maxsize
+        )
+
+    def test_set_log_config_raise_error(self):
+        lwl=LoggerWithLoggerId(logger='test_logger',extra={'logid':'test_logid'},loglevel='INFO')
+        with self.assertRaises(ValueError):    
+            lwl.setLogConfig(
+                console_show = True,
+                loglevel='DEBUG',
+                file_name='test.log',
+                when='ERROR-WHEN',
+                interval=0, # 测试interval<1时，自动更新为1
+                max_bytes=None, # 测试not max_bytes or max_bytes <= 0时，自动更新为sys.maxsize
+                total_size_limit=None, # 测试not total_size_limit or total_size_limit <= 0时，自动更新为sys.maxsize
+                backup_count=None, # 测试not backup_count or backup_count <= 0时，自动更新为sys.maxsize
+            )
+
+    def test_rolling_with_time(self):
+        time_msgs = ['S', 'M', 'H', 'D', 'MIDNIGHT']
+        for time_msg in time_msgs:
+            logger = logging.getLogger('CustomLogger')
+            logger.setLevel(logging.DEBUG)
+            handler = SizeAndTimeRotatingFileHandler(
+                filename ='test.log', 
+                when=time_msg, 
+                interval=1, 
+                max_bytes=1024*100*1024, 
+                backup_count=10, 
+                total_size_limit=1024*300*1024
+            )
+            formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+            handler.setFormatter(formatter)
+            logger.addHandler(handler)
+
+            for _ in range(2):
+                logger.info("This is a test log message.")
+                time.sleep(0.1)
+
+    def test_rolling_with_size(self):
+        logger = logging.getLogger('CustomLogger')
+        logger.setLevel(logging.DEBUG)
+        handler = SizeAndTimeRotatingFileHandler(
+            filename ='test.log', 
+            when='S', 
+            interval=10, 
+            max_bytes=1*1024, 
+            backup_count=2, 
+            total_size_limit=1024*300*1024
+        )
+        formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+
+        for i in range(100):
+            logger.info("This is a test log message."*100)
+            time.sleep(0.001)
+
+    def test_rolling_to_total_max_size(self):
+        logger = logging.getLogger('CustomLogger')
+        logger.setLevel(logging.DEBUG)
+        handler = SizeAndTimeRotatingFileHandler(
+            filename ='test.log', 
+            when='S', 
+            interval=100, 
+            max_bytes=10*1024, 
+            backup_count=10000, 
+            total_size_limit=20*1024
+        )
+        formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+
+        for i in range(100):
+            logger.info("This is a test log message."*100)
+            time.sleep(0.001)
+
+if __name__ == '__main__':
+    unittest.main()

python/utils/logger_file_headler.py

@@ -0,0 +1,91 @@
+# Copyright (c) 2024 Baidu, Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import time
+import glob
+import logging
+from datetime import datetime, timedelta
+
+class SizeAndTimeRotatingFileHandler(logging.Handler):
+    def __init__(self, filename, when='S', interval=1, max_bytes=0, backup_count=0, total_size_limit=0):
+        super().__init__()
+        self.base_filename = filename
+        self.when = when.upper()
+        self.interval = interval
+        self.max_bytes = max_bytes
+        self.backup_count = backup_count
+        self.total_size_limit = total_size_limit
+        self.current_time = datetime.now()
+        self.current_file = self.base_filename
+        self.stream = open(self.current_file, 'a')
+        self.last_rollover = time.time()
+
+    def _get_new_filename(self):
+        suffix = self.current_time.strftime("%Y-%m-%d_%H-%M-%S")
+        return f"{self.base_filename}.{suffix}"
+
+    def emit(self, record):
+        if self.shouldRollover(record):
+            self.doRollover()
+        self.stream.write(self.format(record) + '\n')
+        self.stream.flush()
+
+    def shouldRollover(self, record):
+        current_time = time.time()
+        current_size = os.path.getsize(self.current_file)
+
+        time_rollover = False
+        if self.when == 'S':
+            time_rollover = current_time >= self.last_rollover + self.interval
+        elif self.when == 'M':
+            time_rollover = current_time >= self.last_rollover + self.interval * 60
+        elif self.when == 'H':
+            time_rollover = current_time >= self.last_rollover + self.interval * 3600
+        elif self.when == 'D':
+            time_rollover = current_time >= self.last_rollover + self.interval * 86400
+        elif self.when == 'MIDNIGHT':
+            time_rollover = datetime.fromtimestamp(current_time).date() != datetime.fromtimestamp(self.last_rollover).date()
+
+        size_rollover = current_size >= self.max_bytes if self.max_bytes > 0 else False
+
+        return time_rollover or size_rollover
+
+    def doRollover(self):
+        self.stream.close()
+        self.current_time = datetime.now()
+        new_filename = self._get_new_filename()
+        os.rename(self.current_file, new_filename)  # Rename current file to new name
+        self.current_file = self.base_filename
+        self.stream = open(self.current_file, 'a')
+        self.last_rollover = time.time()
+        self.manage_log_files()
+
+    def manage_log_files(self):
+        log_files = sorted(glob.glob(f"{self.base_filename}.*"), key=os.path.getmtime)
+
+        while len(log_files) > self.backup_count:
+            oldest_log = log_files.pop(0)
+            os.remove(oldest_log)
+
+        while self._total_size(log_files) > self.total_size_limit:
+            if log_files:
+                oldest_log = log_files.pop(0)
+                os.remove(oldest_log)
+
+    def _total_size(self, files):
+        return sum(os.path.getsize(f) for f in files if os.path.exists(f))
+
+    def close(self):
+        self.stream.close()
+        super().close()