✨ configurable log level

haliphax · Apr 9, 2024 · 5c2a86d · 5c2a86d
1 parent 1e2c0eb
commit 5c2a86d
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 10 deletions.
diff --git a/data/config.example.toml b/data/config.example.toml
@@ -8,9 +8,11 @@ port = 6379
 bind = "postgres://xthulu:xthulu@db:5432/xthulu"
 
 [debug]
-enabled = false
 term = false
 
+[logging]
+level = "INFO"
+
 [ssh]
 host = "0.0.0.0"
 host_keys = ["data/ssh_host_key"]

diff --git a/tests/ssh/test_start_server.py b/tests/ssh/test_start_server.py
@@ -4,6 +4,7 @@
 from typing import Any
 
 # stdlib
+from logging import DEBUG, Logger
 from unittest.async_case import IsolatedAsyncioTestCase
 from unittest.mock import AsyncMock, Mock, patch
 
@@ -94,7 +95,6 @@ async def test_proxy_procotol(self, mock_listener: Mock):
         patch_get_config(
             {
                 **test_config,
-                "debug": {"enabled": True},
                 "ssh": {**test_ssh_config, "proxy_protocol": True},
             }
         ),
@@ -103,8 +103,12 @@ async def test_proxy_procotol(self, mock_listener: Mock):
     async def test_trace_malloc_start(self, mock_start: Mock):
         """Server should call tracemalloc.start if debugging is enabled."""
 
-        # act
-        await start_server()
+        with patch.object(Logger, "getEffectiveLevel") as mock_level:
+            # arrange
+            mock_level.return_value = DEBUG
 
-        # assert
-        mock_start.assert_called_once()
+            # act
+            await start_server()
+
+            # assert
+            mock_start.assert_called_once()
diff --git a/xthulu/configuration/default.py b/xthulu/configuration/default.py
@@ -15,6 +15,9 @@
     "db": {
         "bind": "postgres://xthulu:xthulu@db:5432/xthulu",
     },
+    "logging": {
+        "level": "INFO",
+    },
     "ssh": {
         "auth": {
             "bad_usernames": [

diff --git a/xthulu/logger.py b/xthulu/logger.py
@@ -1,7 +1,7 @@
 """Logger setup"""
 
 # stdlib
-from logging import DEBUG, Formatter, getLogger, INFO, StreamHandler
+from logging import Formatter, getLogger, StreamHandler
 from logging.handlers import TimedRotatingFileHandler
 from sys import stdout
 
@@ -26,4 +26,4 @@
 streamHandler.setFormatter(formatter)
 log.addHandler(fileHandler)
 log.addHandler(streamHandler)
-log.setLevel(DEBUG if bool(get_config("debug.enabled", False)) else INFO)
+log.setLevel(str(get_config("logging.level", "INFO")).upper())
diff --git a/xthulu/ssh/__init__.py b/xthulu/ssh/__init__.py
@@ -4,6 +4,7 @@
 from typing import Any
 
 # stdlib
+from logging import DEBUG
 from tracemalloc import start
 
 # 3rd party
@@ -44,7 +45,7 @@ async def start_server():
         log.info("Using PROXY protocol v1 listener")
         kwargs["tunnel"] = ProxyProtocolListener()
 
-    if bool(get_config("debug.enabled", False)):
+    if log.getEffectiveLevel() == DEBUG:
         start()
 
     await res.db.set_bind(res.db.bind)

diff --git a/xthulu/ssh/server.py b/xthulu/ssh/server.py
@@ -1,6 +1,7 @@
 """SSH server implementation"""
 
 # stdlib
+from logging import DEBUG
 from secrets import compare_digest
 
 # 3rd party
@@ -27,7 +28,7 @@ class SSHServer(AsyncSSHServer):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self._debug_enabled = bool(get_config("debug.enabled", False))
+        self._debug_enabled = log.getEffectiveLevel() == DEBUG
         self._no_entry = get_config("ssh.auth.bad_usernames", [])
         self._no_password = get_config("ssh.auth.no_password", [])