Merge pull request #337 from ansforge/chore/converter-log-version

chore(converter): add version in logs

Author: SimonClo

.github/workflows/release.yml

@@ -79,3 +79,4 @@ jobs:
           platforms: linux/amd64
           tags: ghcr.io/${{ github.repository_owner }}/hub-converter:${{ steps.extract_info.outputs.version }}
           context: ./converter
+          build-args: CONVERTER_VERSION=${{ steps.extract_info.outputs.version }}

converter/Dockerfile

@@ -1,6 +1,8 @@
 # Use Python 3.11 slim as base image
 FROM python:3.11-slim
 
+ARG CONVERTER_VERSION
+
 # Set environment variables
 ENV PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1 \
@@ -47,5 +49,7 @@ EXPOSE 8080
 HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
     CMD curl -f http://localhost:8080/health || exit 1
 
+ENV CONVERTER_VERSION=${CONVERTER_VERSION}
+
 # Use Gunicorn for production deployment
 CMD ["uv", "run", "--no-dev", "gunicorn", "-w", "4", "-b", "0.0.0.0:8080", "converter.converter:app"]

converter/converter/logging_config.py

@@ -4,6 +4,8 @@
 from flask import has_request_context, g
 from enum import Enum
 
+CONVERTER_VERSION = os.getenv("CONVERTER_VERSION")
+
 
 class LoggingKeys(Enum):
     DISTRIBUTION_ID = "distributionId"
@@ -14,13 +16,20 @@ class LoggingKeys(Enum):
 
 # Using filter to add context variable: https://docs.python.org/3/howto/logging-cookbook.html#using-filters-to-impart-contextual-information
 class DistributionContextFilter(logging.Filter):
-    def filter(self, record):
+    def filter(self, record: logging.LogRecord) -> bool:
         if has_request_context():
             for key in LoggingKeys:
                 setattr(record, key.value, getattr(g, key.value, None))
         return True
 
 
+class VersionFilter(logging.Filter):
+    def filter(self, record: logging.LogRecord) -> bool:
+        if CONVERTER_VERSION:
+            record.version = CONVERTER_VERSION
+        return True
+
+
 def configure_logging():
     root = logging.getLogger()
     for h in root.handlers[:]:
@@ -37,6 +46,7 @@ def configure_logging():
     )
     handler.setFormatter(formatter)
     handler.addFilter(DistributionContextFilter())
+    handler.addFilter(VersionFilter())
 
     root.addHandler(handler)