Logging

Dockerfile

@@ -30,7 +30,10 @@ COPY ./commons commons
 COPY ./media media
 COPY ./scripts scripts
 COPY ./system_prompts system_prompts
+COPY ./resources resources
 
 COPY ./bot.py bot.py
 
 EXPOSE 8080
+
+CMD ["python3", "bot.py"]

bot.py

@@ -1,6 +1,11 @@
+from commons.loggerfactory import LoggerFactory
+from commons.utils import resource_path
+
+LoggerFactory(resource_path("logging.ini"))
+logger = LoggerFactory.getLogger("main")
 
 if __name__ == '__main__':
-    print("Starting gradio ui application ...")
+    logger.info("Starting gradio ui application ...")
     from scripts.bots.gradio_bot import GradioBot
     gradio_bot = GradioBot()
     gradio_bot.start()

commons/loggerfactory/__init__.py

@@ -0,0 +1,22 @@
+import logging
+import logging.config
+from logging import Logger
+from pathlib import Path
+
+
+class LoggerFactory:
+    def __init__(self, file: str | Path):
+        """
+        Logger factory to simplify
+        :param file: Logger config file
+        """
+        logging.config.fileConfig(file)
+
+    @staticmethod
+    def getLogger(name: str) -> Logger:
+        """
+        A static method to get logger
+        :param name: Name of the logger
+        @return: Logger
+        """
+        return logging.getLogger(name)

commons/utils.py

@@ -13,3 +13,8 @@ def prompt_path(file_name: str):
 
 def media_path(file_name: str):
     return DEFAULT_DIR_PATH / "media" / file_name
+
+
+def resource_path(file_name: str):
+    return DEFAULT_DIR_PATH / "resources" / file_name
+

compose.yaml

@@ -3,6 +3,5 @@ services:
     build: .
     ports:
       - "8080:8080"
-    entrypoint: ["python3", "bot.py"]
     environment:
       - OPENAI_API_KEY

resources/logging.ini

@@ -0,0 +1,33 @@
+[loggers]
+keys=root,simpleExample,httpx
+
+[handlers]
+keys=consoleHandler
+
+[formatters]
+keys=simpleFormatter
+
+[logger_root]
+level=INFO
+handlers=consoleHandler
+
+[logger_simpleExample]
+level=INFO
+handlers=consoleHandler
+qualname=simpleExample
+propagate=0
+
+[logger_httpx]
+level=ERROR
+handlers=consoleHandler
+qualname=httpx
+propagate=0
+
+[handler_consoleHandler]
+class=StreamHandler
+level=INFO
+formatter=simpleFormatter
+args=(sys.stdout,)
+
+[formatter_simpleFormatter]
+format=%(asctime)s - %(threadName)s - %(name)s - %(levelname)s - %(message)s

scripts/bots/gradio_bot.py

@@ -1,5 +1,6 @@
 from openai import OpenAI
 
+from commons.loggerfactory import LoggerFactory
 from commons.utils import prompt_path, media_path
 from scripts.components import OpenAIBot
 from scripts.gradio_ui import GradioBotUI
@@ -17,6 +18,9 @@ class GradioBot:
 
     gradio_bot = GradioBotUI(openai_bot, user_avatar=media_path("user.png"), agent_avatar=media_path("agent.png"))
 
+    def __init__(self):
+        self.logger = LoggerFactory.getLogger(self.__class__.__name__)
+
     def start(self):
-        print("Starting gradio bot ...")
+        self.logger.info("Starting gradio bot ...")
         self.gradio_bot.launch()

scripts/components.py

@@ -4,6 +4,7 @@ from os import PathLike
 
 from openai import OpenAI
 
+from commons.loggerfactory import LoggerFactory
 from commons.utils import getdefault
 from scripts.io import InputOutput
 
@@ -57,6 +58,7 @@ class ChatHistory:
 
 class OpenAIBot:
     def __init__(self, bot: OpenAI, model: str, prompt: PathLike | str, context_span: int, **args):
+        self.logger = LoggerFactory.getLogger(self.__class__.__name__)
         self.__bot = bot
         self.__model = model
         final_prompt = prompt
@@ -83,8 +85,8 @@ class OpenAIBot:
             messages = history.add_message(Role.USER, user_input).get_whole_context()
 
             chat = self.__bot.chat.completions.create(model=self.__model, messages=messages)
-            # print(f"Tokens count, prompts: {chat.usage.prompt_tokens}, completion: {chat.usage.completion_tokens}, "
-            #       f"total: {chat.usage.total_tokens}")
+            self.logger.info("Tokens count, prompts: %s, completion: %s, total: %s",
+                             chat.usage.prompt_tokens, chat.usage.completion_tokens, chat.usage.total_tokens)
             # del messages
 
             reply = chat.choices[0].message.content

scripts/gradio_ui.py

@@ -2,17 +2,19 @@ from pathlib import Path
 
 import gradio as gr
 
+from commons.loggerfactory import LoggerFactory
 from scripts.components import OpenAIBot, DEFAULT_WELCOME_MESSAGE, DEFAULT_EXIT_MESSAGE, ChatHistory
 
 
 class GradioBotUI:
     def __init__(self, bot: OpenAIBot, user_avatar: str | Path, agent_avatar: str | Path):
+        self.logger = LoggerFactory.getLogger(self.__class__.__name__)
         self.bot = bot
         self.user_avatar = user_avatar
         self.agent_avatar = agent_avatar
 
     def launch(self):
-        print("Launching gradio ui ...")
+        self.logger.info("Launching gradio ui ...")
         with gr.Blocks() as demo:
             with gr.Row():
                 gr.Markdown(
@@ -37,7 +39,7 @@ class GradioBotUI:
             user_step.then(self.agent_message, inputs=[state, chatbot], outputs=[prompt, state, chatbot])
 
         demo.launch(server_port=8080, server_name="0.0.0.0")
-        print("Done launching gradio ui!")
+        self.logger.info("Done launching gradio ui!")
 
     def user_message(self, user_text, history):
         return gr.Textbox(label="Prompt"), history + [[user_text, None]]