django-structlog 9.0.1.dev1__tar.gz → 9.1.0__tar.gz

{django_structlog-9.0.1.dev1/django_structlog.egg-info → django_structlog-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: django-structlog
-Version: 9.0.1.dev1
+Version: 9.1.0
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -14,6 +14,7 @@ Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
@@ -36,6 +37,7 @@ Provides-Extra: celery
 Requires-Dist: celery>=5.1; extra == "celery"
 Provides-Extra: commands
 Requires-Dist: django-extensions>=1.4.9; extra == "commands"
+Dynamic: license-file
 
 .. inclusion-marker-introduction-begin
 
@@ -443,7 +445,7 @@ Other libraries alike may be affected by this change.
 Internal changes in how ``RequestMiddleware`` handles exceptions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrode the ``process_exception`` method.
 
 Did you?
 

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0}/README.rst

@@ -404,7 +404,7 @@ Other libraries alike may be affected by this change.
 Internal changes in how ``RequestMiddleware`` handles exceptions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrode the ``process_exception`` method.
 
 Did you?
 

django_structlog-9.1.0/django_structlog/__init__.py

@@ -0,0 +1,7 @@
+"""``django-structlog`` is a structured logging integration for ``Django`` project using ``structlog``."""
+
+name = "django_structlog"
+
+VERSION = (9, 1, 0)
+
+__version__ = ".".join(str(v) for v in VERSION)

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0}/django_structlog/app_settings.py

@@ -11,6 +11,10 @@ class AppSettings:
     def CELERY_ENABLED(self) -> bool:
         return getattr(settings, self.PREFIX + "CELERY_ENABLED", False)
 
+    @property
+    def IP_LOGGING_ENABLED(self) -> bool:
+        return getattr(settings, self.PREFIX + "IP_LOGGING_ENABLED", True)
+
     @property
     def STATUS_4XX_LOG_LEVEL(self) -> int:
         return getattr(settings, self.PREFIX + "STATUS_4XX_LOG_LEVEL", logging.WARNING)

django_structlog-9.1.0/django_structlog/celery/__init__.py

@@ -0,0 +1 @@
+"""``celery`` integration for ``django_structlog``."""

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0}/django_structlog/celery/receivers.py

@@ -1,3 +1,4 @@
+import time
 from typing import TYPE_CHECKING, Any, Optional, Type, cast
 
 import structlog
@@ -93,6 +94,8 @@ class CeleryReceiver:
         signals.bind_extra_task_metadata.send(
             sender=self.receiver_task_prerun, task=task, logger=logger
         )
+        # Record the start time so we can log the task duration later.
+        task.request._django_structlog_started_at = time.monotonic_ns()
         logger.info("task_started", task=task.name)
 
     def receiver_task_retry(
@@ -105,12 +108,15 @@ class CeleryReceiver:
         logger.warning("task_retrying", reason=reason)
 
     def receiver_task_success(
-        self, result: Optional[str] = None, **kwargs: Any
+        self, result: Optional[str] = None, sender: Optional[Any] = None, **kwargs: Any
     ) -> None:
         signals.pre_task_succeeded.send(
             sender=self.receiver_task_success, logger=logger, result=result
         )
-        logger.info("task_succeeded")
+
+        log_vars: dict[str, Any] = {}
+        self.add_duration_ms(sender, log_vars)
+        logger.info("task_succeeded", **log_vars)
 
     def receiver_task_failure(
         self,
@@ -122,17 +128,31 @@ class CeleryReceiver:
         *args: Any,
         **kwargs: Any,
     ) -> None:
+        log_vars: dict[str, Any] = {}
+        self.add_duration_ms(sender, log_vars)
         throws = getattr(sender, "throws", ())
         if isinstance(exception, throws):
             logger.info(
                 "task_failed",
                 error=str(exception),
+                **log_vars,
             )
         else:
             logger.exception(
                 "task_failed",
                 error=str(exception),
                 exception=exception,
+                **log_vars,
+            )
+
+    @classmethod
+    def add_duration_ms(
+        cls, task: Optional[Type[Any]], log_vars: dict[str, Any]
+    ) -> None:
+        if task and hasattr(task, "_django_structlog_started_at"):
+            started_at: int = task.request._django_structlog_started_at
+            log_vars["duration_ms"] = round(
+                (time.monotonic_ns() - started_at) / 1_000_000
             )
 
     def receiver_task_revoked(

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0}/django_structlog/middlewares/request.py

@@ -21,6 +21,7 @@ from asgiref import sync
 from django.core.exceptions import PermissionDenied
 from django.core.signals import got_request_exception
 from django.http import Http404, StreamingHttpResponse
+from django.utils.functional import SimpleLazyObject
 
 from .. import signals
 from ..app_settings import app_settings
@@ -39,6 +40,7 @@ else:
 if TYPE_CHECKING:  # pragma: no cover
     from types import TracebackType
 
+    from django.contrib.auth.base_user import AbstractBaseUser
     from django.http import HttpRequest, HttpResponse
 
 logger = structlog.getLogger(__name__)
@@ -179,8 +181,6 @@ class RequestMiddleware:
         structlog.contextvars.clear_contextvars()
 
     def prepare(self, request: "HttpRequest") -> None:
-        from ipware import get_client_ip  # type: ignore[import-untyped]
-
         request_id = get_request_header(
             request, "x-request-id", "HTTP_X_REQUEST_ID"
         ) or str(uuid.uuid4())
@@ -191,8 +191,8 @@ class RequestMiddleware:
         self.bind_user_id(request)
         if correlation_id:
             structlog.contextvars.bind_contextvars(correlation_id=correlation_id)
-        ip, _ = get_client_ip(request)
-        structlog.contextvars.bind_contextvars(ip=ip)
+        if app_settings.IP_LOGGING_ENABLED:
+            self.bind_ip(request)
         log_kwargs = {
             "request": self.format_request(request),
             "user_agent": request.META.get("HTTP_USER_AGENT"),
@@ -202,6 +202,13 @@ class RequestMiddleware:
         )
         logger.info("request_started", **log_kwargs)
 
+    @classmethod
+    def bind_ip(cls, request: "HttpRequest") -> None:
+        from ipware import get_client_ip  # type: ignore[import-untyped]
+
+        ip, _ = get_client_ip(request)
+        structlog.contextvars.bind_contextvars(ip=ip)
+
     @staticmethod
     def format_request(request: "HttpRequest") -> str:
         return f"{request.method} {request.get_full_path()}"
@@ -209,7 +216,14 @@ class RequestMiddleware:
     @staticmethod
     def bind_user_id(request: "HttpRequest") -> None:
         user_id_field = app_settings.USER_ID_FIELD
-        if hasattr(request, "user") and request.user is not None and user_id_field:
+        if not user_id_field or not hasattr(request, "user"):
+            return
+
+        session_was_accessed = (
+            request.session.accessed if hasattr(request, "session") else None
+        )
+
+        if request.user is not None:
             user_id = None
             if hasattr(request.user, user_id_field):
                 user_id = getattr(request.user, user_id_field)
@@ -217,6 +231,17 @@ class RequestMiddleware:
                     user_id = str(user_id)
             structlog.contextvars.bind_contextvars(user_id=user_id)
 
+        if session_was_accessed is False:
+            """using SessionMiddleware but user was never accessed, must reset accessed state"""
+            user = request.user
+
+            def get_user() -> Any:
+                request.session.accessed = True
+                return user
+
+            request.user = cast("AbstractBaseUser", SimpleLazyObject(get_user))
+            request.session.accessed = False
+
     def process_got_request_exception(
         self, sender: Type[Any], request: "HttpRequest", **kwargs: Any
     ) -> None:

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0/django_structlog.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: django-structlog
-Version: 9.0.1.dev1
+Version: 9.1.0
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
@@ -14,6 +14,7 @@ Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
@@ -36,6 +37,7 @@ Provides-Extra: celery
 Requires-Dist: celery>=5.1; extra == "celery"
 Provides-Extra: commands
 Requires-Dist: django-extensions>=1.4.9; extra == "commands"
+Dynamic: license-file
 
 .. inclusion-marker-introduction-begin
 
@@ -443,7 +445,7 @@ Other libraries alike may be affected by this change.
 Internal changes in how ``RequestMiddleware`` handles exceptions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrided the ``process_exception`` method.
+This only affects you if you implemented a middleware inheriting from ``RequestMiddleware`` and you overrode the ``process_exception`` method.
 
 Did you?
 

{django_structlog-9.0.1.dev1 → django_structlog-9.1.0}/pyproject.toml

@@ -24,6 +24,7 @@ build-backend = "setuptools.build_meta"
     "Framework :: Django :: 4.2",
     "Framework :: Django :: 5.0",
     "Framework :: Django :: 5.1",
+    "Framework :: Django :: 5.2",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.9",
@@ -102,9 +103,9 @@ build-backend = "setuptools.build_meta"
     # Also, make sure that all python versions used here are included in ./github/worksflows/main.yml
     envlist =
         py{39,310,311}-django42-celery5{2,3}-redis{3,4}-kombu5,
-        py31{0,1}-django5{0,1}-celery5{3,4}-redis4-kombu5,
-        py312-django{42,50,51}-celery5{3,4}-redis4-kombu5,
-        py313-django{51}-celery5{3,4}-redis4-kombu5,
+        py31{0,1}-django5{0,1,2}-celery5{3,4}-redis4-kombu5,
+        py312-django{42,50,51,52}-celery5{3,4}-redis4-kombu5,
+        py313-django5{1,2}-celery5{3,4}-redis4-kombu5,
 
     [gh-actions]
     python =
@@ -132,6 +133,7 @@ build-backend = "setuptools.build_meta"
         django42: Django >=4.2, <5.0
         django50: Django >=5.0, <5.1
         django51: Django >=5.1, <5.2
+        django52: Django >=5.2, <6.0
         -r{toxinidir}/requirements/ci.txt
 
     commands = pytest --cov=./test_app --cov=./django_structlog --cov-append test_app

django_structlog-9.0.1.dev1/django_structlog/__init__.py

@@ -1,8 +0,0 @@
-""" ``django-structlog`` is a structured logging integration for ``Django`` project using ``structlog``.
-"""
-
-name = "django_structlog"
-
-VERSION = (9, 0, 1, "dev1")
-
-__version__ = ".".join(str(v) for v in VERSION)

django_structlog-9.0.1.dev1/django_structlog/celery/__init__.py

@@ -1,2 +0,0 @@
-""" ``celery`` integration for ``django_structlog``.
-"""