created logger.py to serve get_logger to all modules

Author: exowanderer

gswikichat/__init__.py

@@ -1 +1,2 @@
+# from .logger import logger
 from .api import *

gswikichat/api.py

@@ -8,33 +8,10 @@
 from .vector_store_interface import embedder, retriever, input_documents
 
 from haystack import Document
+from .logger import get_logger
 
-import logging
-import sys
-
-# TODO: Test if this can be added to the `__init__.py` file
-# TODO: Add volume to Dockerfile for `gbnc_api.log` file
-# Source: https://docs.python.org/3/howto/logging.html
-logging.basicConfig(
-    filename='gbnc_api.log',
-    encoding='utf-8',
-    level=logging.DEBUG
-)
-
-# Source: https://stackoverflow.com/questions/14058453/
-# making-python-loggers-output-all-messages-to-stdout-in-addition-to-log-file
-logger = logging.getLogger('gswikicat api')
-logger.setLevel(logging.DEBUG)
-
-handler = logging.StreamHandler(sys.stdout)
-handler.setLevel(logging.DEBUG)
-formatter = logging.Formatter(
-    '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
-)
-handler.setFormatter(formatter)
-logger.addHandler(handler)
-# End of logging logger configuration
-
+# Create logger instance from base logger config in `logger.py`
+logger = get_logger(__name__)
 
 STATIC_DIR = 'frontend/dist'
 LANDING_PAGE = f'/{STATIC_DIR}'

gswikichat/llm_config.py

@@ -1,8 +1,11 @@
 import os
 from haystack_integrations.components.generators.ollama import OllamaGenerator
 
-import logging
-logger = logging.getLogger()
+from .logger import get_logger
+
+# Create logger instance from base logger config in `logger.py`
+logger = get_logger(__name__)
+
 
 OLLAMA_MODEL_NAME = os.environ.get("OLLAMA_MODEL_NAME")
 OLLAMA_URL = os.environ.get("OLLAMA_URL")
@@ -14,7 +17,8 @@
 
 logger.debug(f'I AM HERE')
 
-print(f"Setting up ollama with {OLLAMA_MODEL_NAME}")
+logger.info(f"Setting up ollama with {OLLAMA_MODEL_NAME}")
+
 llm = OllamaGenerator(
     model=OLLAMA_MODEL_NAME,
     url=OLLAMA_GENERATE_URL

gswikichat/logger.py

@@ -0,0 +1,30 @@
+import logging
+import sys
+
+
+def get_logger(name):
+    # Create a logger
+    # Source: https://docs.python.org/3/howto/logging.html
+    logging.basicConfig(
+        filename='gbnc_api.log',
+        encoding='utf-8',
+        level=logging.DEBUG
+    )
+
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)  # Set the logging level
+
+    # Source: stackoverflow.com/questions/14058453/
+    #   making-python-loggers-output-all-messages-
+    #   to-stdout-in-addition-to-log-file
+
+    # Create console handler and set level to debug
+    handler = logging.StreamHandler(sys.stdout)
+    handler.setLevel(logging.DEBUG)
+    formatter = logging.Formatter(
+        '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    )
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+    return logger