Add dotpath to logs for better traceability of log origin

Author: matti-lamppu

api/graphql/types/reservation_units/mutations.py

@@ -1,26 +1,23 @@
+import logging
+
 import graphene
 from auditlog.models import LogEntry
 from django.conf import settings
 from graphene_django.rest_framework.mutation import SerializerMutation
 from graphql import GraphQLError
 
 from api.graphql.extensions.legacy_helpers import OldAuthSerializerMutation
-from api.graphql.types.reservation_units.permissions import (
-    ReservationUnitPermission,
-)
+from api.graphql.types.reservation_units.permissions import ReservationUnitPermission
 from api.graphql.types.reservation_units.serializers import (
     ReservationUnitCreateSerializer,
     ReservationUnitUpdateSerializer,
 )
-from api.graphql.types.reservation_units.types import (
-    ReservationUnitType,
-)
+from api.graphql.types.reservation_units.types import ReservationUnitType
 from opening_hours.errors import HaukiAPIError, HaukiRequestError
 from opening_hours.utils.hauki_resource_hash_updater import HaukiResourceHashUpdater
 from reservation_units.models import (
     ReservationUnit,
 )
-from tilavarauspalvelu.utils import logging
 
 logger = logging.getLogger(__name__)
 

opening_hours/management/commands/update_hauki_hashes.py

@@ -1,11 +1,11 @@
+import logging
 from typing import Any
 
 from django.core.management.base import BaseCommand
 
 from opening_hours.utils.hauki_resource_hash_updater import HaukiResourceHashUpdater
-from tilavarauspalvelu.utils.logging import getLogger
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 class Command(BaseCommand):

opening_hours/utils/hauki_api_client.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+import logging
 from typing import NotRequired, TypedDict, Unpack
 
 from django.conf import settings
@@ -12,7 +13,6 @@
     HaukiAPIResource,
     HaukiAPIResourceListResponse,
 )
-from tilavarauspalvelu.utils import logging
 
 __all__ = [
     "HaukiAPIClient",

opening_hours/utils/hauki_resource_hash_updater.py

@@ -1,3 +1,4 @@
+import logging
 from datetime import datetime, time
 
 from django.utils import timezone
@@ -8,9 +9,8 @@
 from opening_hours.utils.hauki_api_client import HaukiAPIClient
 from opening_hours.utils.hauki_api_types import HaukiAPIResource, HaukiAPIResourceListResponse
 from opening_hours.utils.reservable_time_span_client import ReservableTimeSpanClient
-from tilavarauspalvelu.utils.logging import getLogger
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 DEFAULT_TIMEZONE = get_default_timezone()
 

tilavarauspalvelu/logging.py

@@ -0,0 +1,29 @@
+import logging
+from pathlib import Path
+
+BASE_PATH = str(Path(__file__).resolve().parent.parent)
+
+
+class TVPFormatter(logging.Formatter):
+    def format(self, record):
+        self._style._defaults = {"dotpath": self.get_dotpath(record)}
+        return super().format(record)
+
+    def get_dotpath(self, record: logging.LogRecord) -> str:
+        """Try to fetch the full dot import path for the module the log happened at."""
+        # For library logs
+        split_path = record.pathname.split("site-packages")
+        if len(split_path) > 1:
+            return self.format_dotpath(split_path[-1][1:])
+
+        # For our logs
+        split_path = record.pathname.split(str(BASE_PATH))
+        if len(split_path) > 1:
+            return self.format_dotpath(split_path[-1][1:])
+
+        # Fall back to the module name, which doesn't include the full path info
+        return record.module
+
+    @staticmethod
+    def format_dotpath(path: str) -> str:
+        return path.removesuffix(".py").replace("/", ".").replace("\\", ".")

tilavarauspalvelu/settings.py

@@ -10,8 +10,6 @@
 from helusers import defaults
 from sentry_sdk.integrations.django import DjangoIntegration
 
-from .utils.logging import getLogger
-
 # This is a temporary fix for graphene_permissions to avoid ImportError when importing ResolveInfo
 # This can be removed when graphene_permissions is updated to import ResolveInfo from the correct package.
 graphql.ResolveInfo = graphql.GraphQLResolveInfo
@@ -340,7 +338,8 @@
     "filters": {},
     "formatters": {
         "common": {
-            "format": "{asctime} | {levelname} | {module}.{funcName}:{lineno} | {message}",
+            "()": "tilavarauspalvelu.logging.TVPFormatter",
+            "format": "{asctime} | {levelname} | {dotpath}.{funcName}:{lineno} | {message}",
             "datefmt": "%Y-%m-%dT%H:%M:%S%z",
             "style": "{",
         },