Merge pull request #123 from GabrielSalla/http-server-log-config

HTTP server log config

Author: GabrielSalla

configs/configs-scalable.yaml

@@ -33,6 +33,7 @@ application_queue:
 
 http_server:
   port: 8000
+  log_level: error
 
 time_zone: America/Sao_Paulo
 

configs/configs.yaml

@@ -28,6 +28,7 @@ application_queue:
 
 http_server:
   port: 8000
+  log_level: error
 
 time_zone: America/Sao_Paulo
 

resources/kubernetes_template/config_map.yaml

@@ -39,6 +39,7 @@ data:
 
     http_server:
       port: 8000
+      log_level: error
 
     time_zone: America/Sao_Paulo
 

src/components/http_server/monitor_routes.py

@@ -16,7 +16,6 @@
 
 _logger = logging.getLogger("monitor_routes")
 
-
 monitor_routes = web.RouteTableDef()
 base_route = "/monitor"
 

src/components/http_server/server.py

@@ -14,6 +14,7 @@
 from components.http_server.issue_routes import issue_routes
 from components.http_server.monitor_routes import monitor_routes
 from configs import configs
+from utils.log import set_logger_level
 
 _logger = logging.getLogger("http_server")
 
@@ -75,6 +76,9 @@ async def init(controller_enabled: bool = False) -> None:
     global _runner
 
     app = web.Application()
+    set_logger_level(logging.getLogger("aiohttp.web"), configs.http_server.log_level)
+    set_logger_level(logging.getLogger("aiohttp.access"), configs.http_server.log_level)
+
     app.add_routes(base_routes)
 
     # Only the controller can receive action requests

src/configs/configs_loader.py

@@ -33,6 +33,7 @@ class ApplicationDatabaseConfig:
 @dataclass
 class HttpServerConfig:
     port: int
+    log_level: Literal["default", "warning", "error", "none"] = "default"
 
 
 @dataclass

src/utils/log.py

@@ -1,5 +1,6 @@
 import json
 import logging
+from typing import Literal
 
 from configs import configs
 
@@ -62,6 +63,18 @@ def format(self, record: logging.LogRecord) -> str:
         return json.dumps(message_dict, default=str)
 
 
+def set_logger_level(
+    logger: logging.Logger, level: Literal["none", "error", "warning", "default"]
+) -> logging.Logger:
+    if level == "none":
+        logger.disabled = True
+    elif level == "error":
+        logger.setLevel(logging.ERROR)
+    elif level == "warning":
+        logger.setLevel(logging.WARNING)
+    return logger
+
+
 def setup() -> None:
     """Setup the logging"""
     stream = logging.StreamHandler()

tests/utils/test_log.py

@@ -24,6 +24,94 @@ def set_json_formatter(monkeypatch, fields: dict[str, str] | None) -> None:
     log.setup()
 
 
+def test_set_logger_level_none(capsys, monkeypatch):
+    """'set_logger_level' should disable the logger if log level is 'none'"""
+    set_json_formatter(monkeypatch, None)
+
+    logger = logging.getLogger("test_set_logger_level_none")
+    log.set_logger_level(logger, "none")
+
+    logger.info("Info log message")
+    logger.warning("Warning log message")
+    logger.error("Error log message")
+    logger.critical("Critical log message")
+
+    captured_message = capsys.readouterr().err.strip()
+
+    assert captured_message == ""
+
+
+def test_set_logger_level_error(capsys, monkeypatch):
+    """'set_logger_level' should show only error and critical messages if log level is 'error'"""
+    set_json_formatter(monkeypatch, None)
+
+    logger = logging.getLogger("test_set_logger_level_error")
+    log.set_logger_level(logger, "error")
+
+    logger.info("Info log message")
+    logger.warning("Warning log message")
+    logger.error("Error log message")
+    logger.critical("Critical log message")
+
+    captured_message = capsys.readouterr().err.strip()
+
+    assert captured_message == "\n".join(
+        [
+            '{"message": "Error log message"}',
+            '{"message": "Critical log message"}',
+        ]
+    )
+
+
+def test_set_logger_level_warning(capsys, monkeypatch):
+    """'set_logger_level' should show only warning, error and critical messages if log level is
+    'warning'"""
+    set_json_formatter(monkeypatch, None)
+
+    logger = logging.getLogger("test_set_logger_level_warning")
+    log.set_logger_level(logger, "warning")
+
+    logger.info("Info log message")
+    logger.warning("Warning log message")
+    logger.error("Error log message")
+    logger.critical("Critical log message")
+
+    captured_message = capsys.readouterr().err.strip()
+
+    assert captured_message == "\n".join(
+        [
+            '{"message": "Warning log message"}',
+            '{"message": "Error log message"}',
+            '{"message": "Critical log message"}',
+        ]
+    )
+
+
+def test_set_logger_level_default(capsys, monkeypatch):
+    """'set_logger_level' should show info, warning, error and critical messages if log level is
+    'default'"""
+    set_json_formatter(monkeypatch, None)
+
+    logger = logging.getLogger("test_set_logger_level_default")
+    log.set_logger_level(logger, "default")
+
+    logger.info("Info log message")
+    logger.warning("Warning log message")
+    logger.error("Error log message")
+    logger.critical("Critical log message")
+
+    captured_message = capsys.readouterr().err.strip()
+
+    assert captured_message == "\n".join(
+        [
+            '{"message": "Info log message"}',
+            '{"message": "Warning log message"}',
+            '{"message": "Error log message"}',
+            '{"message": "Critical log message"}',
+        ]
+    )
+
+
 @pytest.mark.parametrize(
     "log_format",
     [