feat: provide a log level option for log functions (#279)

Author: artemrys

solnlib/log.py

@@ -220,12 +220,16 @@ def set_level(self, level: int, name: str = None):
                 logging.getLogger().setLevel(level)
 
 
-def log_event(logger: logging.Logger, key_values: Dict[str, Any]):
+def log_event(
+    logger: logging.Logger, key_values: Dict[str, Any], log_level: int = logging.INFO
+):
+    """General function to log any event in key-value format."""
     message = " ".join([f"{k}={v}" for k, v in key_values.items()])
-    logger.info(message)
+    logger.log(log_level, message)
 
 
 def modular_input_start(logger: logging.Logger, modular_input_name: str):
+    """Specific function to log the start of the modular input."""
     log_event(
         logger,
         {
@@ -236,6 +240,7 @@ def modular_input_start(logger: logging.Logger, modular_input_name: str):
 
 
 def modular_input_end(logger: logging.Logger, modular_input_name: str):
+    """Specific function to log the end of the modular input."""
     log_event(
         logger,
         {
@@ -248,6 +253,7 @@ def modular_input_end(logger: logging.Logger, modular_input_name: str):
 def events_ingested(
     logger: logging.Logger, modular_input_name: str, sourcetype: str, n_events: int
 ):
+    """Specific function to log the number of events ingested."""
     log_event(
         logger,
         {

tests/unit/test_log.py

@@ -148,8 +148,21 @@ def test_log_event():
             },
         )
 
-        assert mock_logger.info.call_count == 1
-        assert "key=foo value=bar" in mock_logger.info.call_args[0]
+        mock_logger.log.assert_called_once_with(logging.INFO, "key=foo value=bar")
+
+
+def test_log_event_when_debug_log_level():
+    with mock.patch("logging.Logger") as mock_logger:
+        log.log_event(
+            mock_logger,
+            {
+                "key": "foo",
+                "value": "bar",
+            },
+            log_level=logging.DEBUG,
+        )
+
+        mock_logger.log.assert_called_once_with(logging.DEBUG, "key=foo value=bar")
 
 
 def test_modular_input_start():
@@ -159,10 +172,8 @@ def test_modular_input_start():
             "modular_input_name",
         )
 
-        assert mock_logger.info.call_count == 1
-        assert (
-            "action=started modular_input_name=modular_input_name"
-            in mock_logger.info.call_args[0]
+        mock_logger.log.assert_called_once_with(
+            logging.INFO, "action=started modular_input_name=modular_input_name"
         )
 
 
@@ -173,19 +184,16 @@ def test_modular_input_end():
             "modular_input_name",
         )
 
-        assert mock_logger.info.call_count == 1
-        assert (
-            "action=ended modular_input_name=modular_input_name"
-            in mock_logger.info.call_args[0]
+        mock_logger.log.assert_called_once_with(
+            logging.INFO, "action=ended modular_input_name=modular_input_name"
         )
 
 
 def test_events_ingested():
     with mock.patch("logging.Logger") as mock_logger:
         log.events_ingested(mock_logger, "modular_input_name", "sourcetype", 5)
 
-        assert mock_logger.info.call_count == 1
-        assert (
-            "action=events_ingested modular_input_name=modular_input_name sourcetype=sourcetype n_events=5"
-            in mock_logger.info.call_args[0]
+        mock_logger.log.assert_called_once_with(
+            logging.INFO,
+            "action=events_ingested modular_input_name=modular_input_name sourcetype=sourcetype n_events=5",
         )