Update logging for python firewall

aikido_firewall/__init__.py

@@ -2,9 +2,19 @@
 Aggregates from the different modules
 """
 
+from dotenv import load_dotenv
+
 # Import sources
 import aikido_firewall.sources.django
 import aikido_firewall.sources.flask
 
 # Import middleware
 import aikido_firewall.middleware.django
+
+# Import logger
+from aikido_firewall.helpers.logging import logger
+
+# Load environment variables
+load_dotenv()
+
+logger.info("Aikido python firewall started")

aikido_firewall/helpers/logging.py

@@ -0,0 +1,32 @@
+"""
+Logging helper, this will create and set logging
+"""
+
+import logging
+import sys
+import os
+
+
+APPLICATION_NAME = "aikido_firewall"
+
+# Set log level
+aikido_debug_env = os.getenv("AIKIDO_DEBUG")
+LOG_LEVEL = logging.INFO
+if aikido_debug_env is not None:
+    debug = aikido_debug_env.lower() in ["true", "1"]
+    LOG_LEVEL = logging.DEBUG if debug else logging.INFO
+
+# Create a logger
+logger = logging.getLogger(APPLICATION_NAME)
+
+# Configure format
+fmt = logging.Formatter("%(name)s: %(asctime)s | %(levelname)s > %(message)s")
+# Get stdout handler
+stdout = logging.StreamHandler(stream=sys.stdout)
+stdout.setLevel(LOG_LEVEL)
+stdout.setFormatter(fmt)
+logger.addHandler(stdout)
+
+# Configure logger
+logger.setLevel(LOG_LEVEL)
+logger.debug("Created logger")

aikido_firewall/middleware/django.py

@@ -3,7 +3,7 @@
 uses headers, body, etc. as sources
 """
 
-import logging
+from aikido_firewall.helpers.logging import logger
 
 
 class AikidoMiddleware:
@@ -15,17 +15,17 @@ def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request, *args, **kwargs):
-        logging.critical("[AIK] Aikido middleware : call")
+        logger.debug("Aikido middleware for `django` was called : __call__")
         return self.get_response(request)
 
     def process_exception(self, request, exception):
         """
         Do something when an exception occurs whilst django is processing a request
         """
-        logging.critical("[AIK] Aikido middleware : exception")
+        logger.debug("Aikido middleware for `django` was called : process_exception")
 
     def process_request(self, request):
         """
         executed during the request phase of the Django request-response cycle.
         """
-        logging.critical("[AIK] Aikido middleware : request")
+        logger.debug("Aikido middleware for `django` was called : process_request")

aikido_firewall/sources/django.py

@@ -3,6 +3,8 @@
 """
 
 import importhook
+from aikido_firewall.helpers.logging import logger
+
 
 AIKIDO_MIDDLEWARE_ADDR = "aikido_firewall.middleware.django.AikidoMiddleware"
 
@@ -19,5 +21,5 @@ def on_django_import(django):
 
     # pylint: disable=no-member
     setattr(modified_django.settings, "MIDDLEWARE", new_middleware_array)
-    print("[AIK] Modified Django")
+    logger.debug("Wrapped `django` module")
     return modified_django

aikido_firewall/sources/flask.py

@@ -4,8 +4,8 @@
 
 import copy
 from importlib.metadata import version
-import logging
 import importhook
+from aikido_firewall.helpers.logging import logger
 
 
 class AikidoMiddleware:  # pylint: disable=too-few-public-methods
@@ -17,7 +17,7 @@ def __init__(self, app):
         self.app = app
 
     def __call__(self, environ, start_response):
-        logging.critical("[AIK] Aikido middleware is working")
+        logger.debug("Aikido middleware for `flask` was called")
         response = self.app(environ, start_response)
         return response
 
@@ -35,11 +35,10 @@ def on_flask_import(flask):
 
     def aikido_flask_init(_self, *args, **kwargs):
         prev_flask_init(_self, *args, **kwargs)
-        print("[AIK] Flask version : ", version("flask"))
+        logger.debug("Wrapper - `flask` version : %s", version("flask"))
         _self.wsgi_app = AikidoMiddleware(_self.wsgi_app)
-        print(_self)
 
     # pylint: disable=no-member
     setattr(modified_flask.Flask, "__init__", aikido_flask_init)
-    print("[AIK] Modified flask")
+    logger.debug("Wrapped `flask` module")
     return modified_flask

docs/logging.md

@@ -0,0 +1,6 @@
+# Logging
+Aikido by default uses the `INFO` logging level, if you want debug messages from aikido,
+Set the `AIKIDO_DEBUG` environment variable. Like so :
+```env
+AIKIDO_DEBUG=True
+```

pyproject.toml

@@ -8,6 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.12"
 importhook = "^1.0.9"
+python-dotenv = "^1.0.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"