Use common logging configuration for all services

Author: steventux

src/modality_emulator.py

@@ -1,5 +1,4 @@
 import datetime
-import logging
 import os
 import time
 
@@ -18,15 +17,11 @@
 from services.dicom import PENDING, PENDING_WARNING, SUCCESS
 from services.mwl import MWLStatus
 from services.storage import MWLStorage
+from telemetry import configure_logging
 
 load_dotenv()
 
-logging.basicConfig(
-    level=os.getenv("LOG_LEVEL", "INFO").upper(),
-    format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
-)
-
-logger = logging.getLogger(__name__)
+logger = configure_logging("Gateway-Emulator")
 
 
 DICOM_LATERALITIES = ["L", "R"]

src/mwl_main.py

@@ -1,15 +1,16 @@
 """Entry point for MWL server."""
 
-import logging
 import os
 
 from dotenv import load_dotenv
 
 from server import MWLServer
-from telemetry import configure_telemetry
+from telemetry import configure_logging, configure_telemetry
 
 load_dotenv()
 
+logger = configure_logging("Gateway-MWL")
+
 
 def main():
     """
@@ -20,23 +21,24 @@ def main():
     MWL_PORT: Port to listen on (default: 4243)
     MWL_DB_PATH: Path to the SQLite database file (default: /var/lib/pacs/worklist.db)
     """
-    logging.basicConfig(
-        level=os.getenv("LOG_LEVEL", "INFO").upper(),
-        format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
-    )
-
     mwl_aet = os.getenv("MWL_AET", "MWL_SCP")
     mwl_port = int(os.getenv("MWL_PORT", "4243"))
     mwl_db_path = os.getenv("MWL_DB_PATH", "/var/lib/pacs/worklist.db")
 
-    mwl_server = MWLServer(mwl_aet, mwl_port, mwl_db_path, block=True)
+    mwl_server = MWLServer(
+        ae_title=mwl_aet,
+        port=mwl_port,
+        db_path=mwl_db_path,
+        logger=logger,
+        block=True,
+    )
 
     configure_telemetry(service_name="mwl-server")
 
     try:
         mwl_server.start()
     except KeyboardInterrupt:
-        logging.info("Received shutdown signal")
+        logger.info("Received shutdown signal")
         mwl_server.stop()
 
 

src/pacs_main.py

@@ -1,15 +1,16 @@
 """Entry point for PACS server."""
 
-import logging
 import os
 
 from dotenv import load_dotenv
 
 from server import PACSServer
-from telemetry import configure_telemetry
+from telemetry import configure_logging, configure_telemetry
 
 load_dotenv()
 
+logger = configure_logging("Gateway-PACS")
+
 
 def main():
     """
@@ -21,25 +22,28 @@ def main():
     PACS_STORAGE_PATH: Path to store incoming DICOM files (default: /var/lib/pacs/storage)
     PACS_DB_PATH: Path to the SQLite database file (default: /var/lib/pacs/pacs.db)
     """
-    logging.basicConfig(
-        level=os.getenv("LOG_LEVEL", "INFO").upper(),
-        format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
-    )
-
     pacs_aet = os.getenv("PACS_AET", "SCREENING_PACS")
     pacs_port = int(os.getenv("PACS_PORT", "4244"))
     pacs_storage_path = os.getenv("PACS_STORAGE_PATH", "/var/lib/pacs/storage")
     pacs_db_path = os.getenv("PACS_DB_PATH", "/var/lib/pacs/pacs.db")
     mwl_db_path = os.getenv("MWL_DB_PATH", "/var/lib/pacs/worklist.db")
 
-    pacs_server = PACSServer(pacs_aet, pacs_port, pacs_storage_path, pacs_db_path, block=True, mwl_db_path=mwl_db_path)
+    pacs_server = PACSServer(
+        ae_title=pacs_aet,
+        port=pacs_port,
+        storage_path=pacs_storage_path,
+        db_path=pacs_db_path,
+        logger=logger,
+        block=True,
+        mwl_db_path=mwl_db_path,
+    )
 
     configure_telemetry(service_name="pacs-server")
 
     try:
         pacs_server.start()
     except KeyboardInterrupt:
-        logging.info("Received shutdown signal")
+        logger.info("Received shutdown signal")
         pacs_server.stop()
 
 

src/relay_listener.py

@@ -9,7 +9,6 @@
 import hashlib
 import hmac
 import json
-import logging
 import os
 import time
 import urllib.parse
@@ -23,11 +22,11 @@
 from services.mwl.create_worklist_item import CreateWorklistItem
 from services.mwl.update_worklist_item_status import UpdateWorklistItemStatus
 from services.storage import MWLStorage
-from telemetry import configure_telemetry
+from telemetry import configure_logging, configure_telemetry
 
 load_dotenv()
 
-logger = logging.getLogger(__name__)
+logger = configure_logging("Gateway-Relay")
 
 DB_PATH = os.getenv("MWL_DB_PATH", "/var/lib/pacs/worklist.db")
 AZURE_RELAY_SCOPE = "https://relay.azure.net/.default"
@@ -174,13 +173,9 @@ def verify_credentials():
 
 
 async def main():
-    logging.basicConfig(
-        level=os.getenv("LOG_LEVEL", "INFO").upper(),
-        format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
-    )
     configure_telemetry(service_name="relay-listener")
 
-    logger.info("Socket Listener Starting...")
+    logger.info("Gateway Relay Listener Starting...")
     verify_credentials()
     storage = MWLStorage(db_path=DB_PATH)
 

src/server.py

@@ -36,6 +36,7 @@ def __init__(
         port: int = 4244,
         storage_path: str = "/var/lib/pacs/storage",
         db_path: str = "/var/lib/pacs/pacs.db",
+        logger: logging.Logger = logger,
         block: bool = True,
         mwl_db_path: str = "/var/lib/pacs/worklist.db",
     ):
@@ -54,11 +55,12 @@ def __init__(
         self.storage = PACSStorage(db_path, storage_path)
         self.mwl_storage = MWLStorage(mwl_db_path)
         self.ae = None
+        self.logger = logger
         self.block = block
 
     def start(self):
         """Start the PACS server and listen for incoming connections."""
-        logger.info(f"Starting PACS server: {self.ae_title} on port {self.port}")
+        self.logger.info(f"Starting PACS server: {self.ae_title} on port {self.port}")
 
         transfer_syntaxes = [
             dicom_uid.JPEGLosslessSV1,  # Hologic preferred
@@ -78,16 +80,16 @@ def start(self):
             (evt.EVT_C_STORE, CStore(self.storage, mwl_storage=self.mwl_storage).call),
         ]
 
-        logger.info(f"PACS server listening on 0.0.0.0:{self.port}")
-        logger.info(f"Storage: {self.storage.storage_root}")
-        logger.info(f"Database: {self.storage.db_path}")
+        self.logger.info(f"PACS server listening on 0.0.0.0:{self.port}")
+        self.logger.info(f"Storage: {self.storage.storage_root}")
+        self.logger.info(f"Database: {self.storage.db_path}")
 
         self.ae.start_server(("0.0.0.0", self.port), block=self.block, evt_handlers=handlers)  # type: ignore
 
     def stop(self):
         """Stop the PACS server."""
         if self.ae:
-            logger.info("Stopping PACS server")
+            self.logger.info("Stopping PACS server")
             self.ae.shutdown()
         self.storage.close()
 
@@ -100,6 +102,7 @@ def __init__(
         ae_title: str = "MWL_SCP",
         port: int = 4243,
         db_path: str = "/var/lib/pacs/worklist.db",
+        logger: logging.Logger = logger,
         block: bool = True,
     ):
         """
@@ -115,11 +118,12 @@ def __init__(
         self.port = port
         self.storage = MWLStorage(db_path)
         self.ae = None
+        self.logger = logger
         self.block = block
 
     def start(self):
         """Start the MWL server."""
-        logger.info(f"Starting MWL server: {self.ae_title} on port {self.port}")
+        self.logger.info(f"Starting MWL server: {self.ae_title} on port {self.port}")
 
         self.ae = AE(ae_title=self.ae_title)
         self.ae.add_supported_context(Verification)
@@ -133,13 +137,13 @@ def start(self):
             (evt.EVT_N_SET, NSet(self.storage).call),
         ]
 
-        logger.info(f"MWL server listening on 0.0.0.0:{self.port}")
-        logger.info(f"Database: {self.storage.db_path}")
+        self.logger.info(f"MWL server listening on 0.0.0.0:{self.port}")
+        self.logger.info(f"Database: {self.storage.db_path}")
 
         self.ae.start_server(("0.0.0.0", self.port), block=self.block, evt_handlers=handlers)  # type: ignore
 
     def stop(self):
         """Stop the MWL server."""
         if self.ae:
-            logger.info("Stopping MWL server")
+            self.logger.info("Stopping MWL server")
             self.ae.shutdown()

src/upload_main.py

@@ -1,6 +1,5 @@
 """Entry point for DICOM upload listener service."""
 
-import logging
 import os
 
 from dotenv import load_dotenv
@@ -9,7 +8,7 @@
 from services.dicom.upload_listener import UploadListener
 from services.dicom.upload_processor import UploadProcessor
 from services.storage import MWLStorage, PACSStorage
-from telemetry import configure_telemetry
+from telemetry import configure_logging, configure_telemetry
 
 load_dotenv()
 
@@ -28,10 +27,7 @@ def main():
     UPLOAD_POLL_INTERVAL: Time in seconds between polling for new uploads (default: 2)
     UPLOAD_BATCH_SIZE: Number of pending uploads to process in each batch (default: 10)
     """
-    logging.basicConfig(
-        level=os.getenv("LOG_LEVEL", "INFO").upper(),
-        format=os.getenv("LOG_FORMAT", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"),
-    )
+    logger = configure_logging("Gateway-Upload")
 
     poll_interval = float(os.getenv("UPLOAD_POLL_INTERVAL", "2"))
     batch_size = int(os.getenv("UPLOAD_BATCH_SIZE", "10"))
@@ -56,24 +52,24 @@ def main():
         batch_size=batch_size,
     )
 
-    logging.info("=" * 60)
-    logging.info("Starting DICOM upload listener service")
-    logging.info("=" * 60)
-    logging.info(f"PACS DB: {pacs_storage.db_path}")
-    logging.info(f"Worklist DB: {mwl_storage.db_path}")
-    logging.info(f"Storage: {pacs_storage.storage_root}")
-    logging.info(f"Poll interval: {poll_interval}s")
-    logging.info(f"Batch size: {batch_size}")
-    logging.info(f"Max retries: {max_retries}")
-    logging.info(f"API endpoint: {uploader.api_endpoint}")
-    logging.info("=" * 60)
+    logger.info("=" * 60)
+    logger.info("Starting DICOM upload listener service")
+    logger.info("=" * 60)
+    logger.info(f"PACS DB: {pacs_storage.db_path}")
+    logger.info(f"Worklist DB: {mwl_storage.db_path}")
+    logger.info(f"Storage: {pacs_storage.storage_root}")
+    logger.info(f"Poll interval: {poll_interval}s")
+    logger.info(f"Batch size: {batch_size}")
+    logger.info(f"Max retries: {max_retries}")
+    logger.info(f"API endpoint: {uploader.api_endpoint}")
+    logger.info("=" * 60)
 
     configure_telemetry(service_name="upload-listener")
 
     try:
         listener.start()
     except KeyboardInterrupt:
-        logging.info("Received shutdown signal")
+        logger.info("Received shutdown signal")
         listener.stop()
 
 

tests/integration/test_end_to_end_relay_to_upload.py

@@ -6,6 +6,7 @@
 """
 
 import json
+import logging
 from unittest.mock import Mock, patch
 
 import pytest
@@ -81,6 +82,7 @@ def mwl_server(self, mwl_storage):
         server.port = 4243
         server.storage = mwl_storage
         server.ae = None
+        server.logger = logging.getLogger("MWLServer")
         server.block = False
         return server
 
@@ -93,6 +95,7 @@ def pacs_server(self, pacs_storage, mwl_storage):
         server.storage = pacs_storage
         server.mwl_storage = mwl_storage
         server.ae = None
+        server.logger = logging.getLogger("PACSServer")
         server.block = False
         return server
 

tests/scripts/test_database.py

@@ -1,8 +1,9 @@
-import pytest
 import sqlite3
 import sys
 from pathlib import Path
 
+import pytest
+
 sys.path.append(f"{Path(__file__).parent.parent.parent}/scripts/python")
 
 from database import backup_database, reset_worklist_database

tests/test_relay_listener.py

@@ -252,7 +252,7 @@ async def test_main_handles_connection_closed_and_keyboard_interrupt(
     await main()
 
     assert relay_listener_instance.listen.call_count == 3
-    mock_logger.info.assert_any_call("Socket Listener Starting...")
+    mock_logger.info.assert_any_call("Gateway Relay Listener Starting...")
     mock_logger.warning.assert_any_call("Connection closed with code 1011: Something went wrong")
     mock_logger.warning.assert_any_call("Retrying in 5 seconds...")
     mock_logger.warning.assert_any_call("Connection closed with code 1014: Bad gateway")

tests/test_server.py

@@ -17,15 +17,23 @@
 @patch(f"{PACSServer.__module__}.PACSStorage")
 class TestPACSServer:
     def test_init(self, mock_pacs_storage, mock_mwl_storage, tmp_dir):
+        mock_logger = MagicMock()
         subject = PACSServer(
-            "Custom AE Title", 2222, tmp_dir, f"{tmp_dir}/test.db", False, mwl_db_path=f"{tmp_dir}/worklist.db"
+            "Custom AE Title",
+            2222,
+            tmp_dir,
+            f"{tmp_dir}/test.db",
+            logger=mock_logger,
+            block=False,
+            mwl_db_path=f"{tmp_dir}/worklist.db",
         )
 
         assert subject.ae_title == "Custom AE Title"
         assert subject.port == 2222
         assert subject.storage == mock_pacs_storage.return_value
         assert subject.mwl_storage == mock_mwl_storage.return_value
         assert subject.ae is None
+        assert subject.logger == mock_logger
         assert subject.block is False
 
         mock_pacs_storage.assert_called_once_with(f"{tmp_dir}/test.db", tmp_dir)
@@ -80,12 +88,14 @@ def test_stop(self, *_):
 @patch(f"{MWLServer.__module__}.MWLStorage")
 class TestMWLServer:
     def test_init(self, mock_storage):
-        subject = MWLServer("CUSTOM_MWL", 11112, "/custom/path/worklist.db", False)
+        mock_logger = MagicMock()
+        subject = MWLServer("CUSTOM_MWL", 11112, "/custom/path/worklist.db", logger=mock_logger, block=False)
 
         assert subject.ae_title == "CUSTOM_MWL"
         assert subject.port == 11112
         assert subject.storage == mock_storage.return_value
         assert subject.ae is None
+        assert subject.logger == mock_logger
         assert subject.block is False
 
         mock_storage.assert_called_once_with("/custom/path/worklist.db")