formatted logger for applications

Author: Maxwell Dylla

Makefile

@@ -26,11 +26,11 @@ test-unit:
 
 .PHONY: test-integration
 test-integration:
-	pytest tests/integration/ -s
+	pytest tests/integration/ -s --log-cli-level=INFO
 
 .PHONY: test-e2e
 test-e2e:
-	pytest tests/e2e/ -s
+	pytest tests/e2e/ -s --log-cli-level=INFO
 
 .PHONY: docker-image
 docker-image:

src/pulse_telemetry/apps/table_maintenance.py

@@ -1,16 +1,13 @@
 import concurrent.futures
 import datetime
 import functools
-import logging
-import sys
 
 from pyspark.sql import SparkSession
 
+import pulse_telemetry.logging
 from pulse_telemetry.sparklib import iceberg
 
-logger = logging.getLogger("pulse-telemetry")
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+logger = pulse_telemetry.logging.get_logger()
 
 
 class NoTablesFoundError(Exception):

src/pulse_telemetry/apps/telemetry_statistics.py

@@ -1,14 +1,11 @@
 import datetime
-import logging
-import sys
 
 from pyspark.sql import SparkSession
 
+import pulse_telemetry.logging
 from pulse_telemetry.sparklib import iceberg, processing_incremental, statistics_cycle, statistics_step, telemetry
 
-logger = logging.getLogger("pulse-telemetry")
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.INFO)
+logger = pulse_telemetry.logging.get_logger()
 
 
 def create_tables_if_not_exist(spark: SparkSession, catalog_name: str, database_name: str):

src/pulse_telemetry/logging.py

@@ -0,0 +1,12 @@
+import logging
+import sys
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    handlers=[logging.StreamHandler(sys.stdout)],
+)
+
+
+def get_logger():
+    return logging.getLogger("pulse-telemetry")

tests/unit/test_logging.py

@@ -0,0 +1,8 @@
+from pulse_telemetry.logging import get_logger
+
+
+def test_logger_inherits_root_configuration():
+    logger = get_logger()
+    assert not logger.handlers, "The logger should not have its own handlers"
+    assert logger.propagate, "The logger should propagate to the root logger"
+    assert logger.hasHandlers(), "The logger should be able to access the root logger's handler"