django-structlog 7.0.0.dev1__tar.gz → 8.0.0__tar.gz

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.1
 Name: django-structlog
-Version: 7.0.0.dev1
+Version: 8.0.0
 Summary: Structured Logging for Django
 Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
 License: MIT
 Project-URL: homepage, https://github.com/jrobichaud/django-structlog
 Project-URL: repository, https://github.com/jrobichaud/django-structlog
 Project-URL: documentation, https://django-structlog.readthedocs.io
+Project-URL: tracker, https://github.com/jrobichaud/django-structlog/issues
+Project-URL: changelog, https://django-structlog.readthedocs.io/en/latest/changelog.html
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 3.2
@@ -399,6 +401,42 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_8.0:
+
+Upgrading to 8.0+
+^^^^^^^^^^^^^^^^^
+
+A new keyword argument ``log_kwargs`` was added to the the optional signals:
+    - ``django_structlog.signals.bind_extra_request_metadata``;
+    - ``django_structlog.signals.bind_extra_request_finished_metadata``;
+    - ``django_structlog.signals.bind_extra_request_failed_metadata``.
+
+It should not affect you if you have a ``**kwargs`` in the signature of your receivers.
+
+``log_kwargs`` is a dictionary containing the log metadata that will be added to their respective logs (``"request_started"``, ``"request_finished"``, ``"request_failed"``).
+
+If you use any of these signals, you may need to update your receiver to accept this new argument:
+
+.. code-block:: python
+
+    from django.contrib.sites.shortcuts import get_current_site
+    from django.dispatch import receiver
+    from django_structlog import signals
+    import structlog
+
+    @receiver(signals.bind_extra_request_metadata)
+    def my_receiver(request, logger, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_finished_metadata)
+    def my_receiver_finished(request, logger, response, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_failed_metadata)
+    def my_receiver_failed(request, logger, exception, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+
 .. _upgrade_7.0:
 
 Upgrading to 7.0+
@@ -643,6 +681,7 @@ See also the list of `contributors <https://github.com/jrobichaud/django-structl
 Acknowledgments
 ===============
 
+* Very huge thanks to my awesome 🦄 and generous employer `TLM 🩵💜❤️🧡💚🐈‍⬛ <https://tlmgo.com/en/>`_ for letting me maintain this project on my work hours because it believes in open source.
 * Big thanks to `@ferd <https://github.com/ferd>`_ for his `bad opinions <https://ferd.ca/erlang-otp-21-s-new-logger.html>`_ that inspired the author enough to spend time on this library.
 * `This issue <https://github.com/hynek/structlog/issues/175>`_ helped the author to figure out how to integrate ``structlog`` in Django.
 * `This stack overflow question <https://stackoverflow.com/questions/43855507/configuring-and-using-structlog-with-django>`_ was also helpful.

django-structlog-7.0.0.dev1/django_structlog.egg-info/PKG-INFO → django-structlog-8.0.0/README.rst

@@ -1,40 +1,3 @@
-Metadata-Version: 2.1
-Name: django-structlog
-Version: 7.0.0.dev1
-Summary: Structured Logging for Django
-Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
-License: MIT
-Project-URL: homepage, https://github.com/jrobichaud/django-structlog
-Project-URL: repository, https://github.com/jrobichaud/django-structlog
-Project-URL: documentation, https://django-structlog.readthedocs.io
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Framework :: Django :: 4.1
-Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: System :: Logging
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-License-File: LICENSE.rst
-Requires-Dist: django>=3.2
-Requires-Dist: structlog>=21.4.0
-Requires-Dist: asgiref>=3.6.0
-Requires-Dist: django-ipware>=6.0.2
-Provides-Extra: celery
-Requires-Dist: celery>=5.1; extra == "celery"
-Provides-Extra: commands
-Requires-Dist: django-extensions>=1.4.9; extra == "commands"
-
 .. inclusion-marker-introduction-begin
 
 django-structlog
@@ -399,6 +362,42 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_8.0:
+
+Upgrading to 8.0+
+^^^^^^^^^^^^^^^^^
+
+A new keyword argument ``log_kwargs`` was added to the the optional signals:
+    - ``django_structlog.signals.bind_extra_request_metadata``;
+    - ``django_structlog.signals.bind_extra_request_finished_metadata``;
+    - ``django_structlog.signals.bind_extra_request_failed_metadata``.
+
+It should not affect you if you have a ``**kwargs`` in the signature of your receivers.
+
+``log_kwargs`` is a dictionary containing the log metadata that will be added to their respective logs (``"request_started"``, ``"request_finished"``, ``"request_failed"``).
+
+If you use any of these signals, you may need to update your receiver to accept this new argument:
+
+.. code-block:: python
+
+    from django.contrib.sites.shortcuts import get_current_site
+    from django.dispatch import receiver
+    from django_structlog import signals
+    import structlog
+
+    @receiver(signals.bind_extra_request_metadata)
+    def my_receiver(request, logger, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_finished_metadata)
+    def my_receiver_finished(request, logger, response, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_failed_metadata)
+    def my_receiver_failed(request, logger, exception, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+
 .. _upgrade_7.0:
 
 Upgrading to 7.0+
@@ -643,6 +642,7 @@ See also the list of `contributors <https://github.com/jrobichaud/django-structl
 Acknowledgments
 ===============
 
+* Very huge thanks to my awesome 🦄 and generous employer `TLM 🩵💜❤️🧡💚🐈‍⬛ <https://tlmgo.com/en/>`_ for letting me maintain this project on my work hours because it believes in open source.
 * Big thanks to `@ferd <https://github.com/ferd>`_ for his `bad opinions <https://ferd.ca/erlang-otp-21-s-new-logger.html>`_ that inspired the author enough to spend time on this library.
 * `This issue <https://github.com/hynek/structlog/issues/175>`_ helped the author to figure out how to integrate ``structlog`` in Django.
 * `This stack overflow question <https://stackoverflow.com/questions/43855507/configuring-and-using-structlog-with-django>`_ was also helpful.

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/django_structlog/__init__.py

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

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/django_structlog/celery/signals.py

@@ -12,7 +12,7 @@ bind_extra_task_metadata = django.dispatch.Signal()
 >>> import structlog
 >>>
 >>> @receiver(signals.bind_extra_task_metadata)
-... def receiver_bind_extra_request_metadata(sender, signal, task=None, logger=None, **kwargs):
+... def receiver_bind_extra_task_metadata(sender, signal, task=None, logger=None, **kwargs):
 ...     structlog.contextvars.bind_contextvars(correlation_id=task.request.correlation_id)
 
 """

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/django_structlog/middlewares/request.py

@@ -76,7 +76,11 @@ class RequestMiddleware:
 
     async def __acall__(self, request):
         await sync.sync_to_async(self.prepare)(request)
-        response = await self.get_response(request)
+        try:
+            response = await self.get_response(request)
+        except asyncio.CancelledError:
+            logger.warning("request_cancelled")
+            raise
         await sync.sync_to_async(self.handle_response)(request, response)
         return response
 
@@ -84,11 +88,17 @@ class RequestMiddleware:
         if not hasattr(request, "_raised_exception"):
             self.bind_user_id(request)
             context = structlog.contextvars.get_merged_contextvars(logger)
+
+            log_kwargs = dict(
+                code=response.status_code,
+                request=self.format_request(request),
+            )
             signals.bind_extra_request_finished_metadata.send(
                 sender=self.__class__,
                 request=request,
                 logger=logger,
                 response=response,
+                log_kwargs=log_kwargs,
             )
             if response.status_code >= 500:
                 level = logging.ERROR
@@ -99,8 +109,7 @@ class RequestMiddleware:
             logger.log(
                 level,
                 "request_finished",
-                code=response.status_code,
-                request=self.format_request(request),
+                **log_kwargs,
             )
             if isinstance(response, StreamingHttpResponse):
                 streaming_content = response.streaming_content
@@ -142,14 +151,14 @@ class RequestMiddleware:
             structlog.contextvars.bind_contextvars(correlation_id=correlation_id)
         ip, _ = get_client_ip(request)
         structlog.contextvars.bind_contextvars(ip=ip)
+        log_kwargs = {
+            "request": self.format_request(request),
+            "user_agent": request.META.get("HTTP_USER_AGENT"),
+        }
         signals.bind_extra_request_metadata.send(
-            sender=self.__class__, request=request, logger=logger
-        )
-        logger.info(
-            "request_started",
-            request=self.format_request(request),
-            user_agent=request.META.get("HTTP_USER_AGENT"),
+            sender=self.__class__, request=request, logger=logger, log_kwargs=log_kwargs
         )
+        logger.info("request_started", **log_kwargs)
 
     @staticmethod
     def format_request(request):
@@ -174,14 +183,18 @@ class RequestMiddleware:
 
         setattr(request, "_raised_exception", exception)
         self.bind_user_id(request)
+        log_kwargs = dict(
+            code=500,
+            request=self.format_request(request),
+        )
         signals.bind_extra_request_failed_metadata.send(
             sender=self.__class__,
             request=request,
             logger=logger,
             exception=exception,
+            log_kwargs=log_kwargs,
         )
         logger.exception(
             "request_failed",
-            code=500,
-            request=self.format_request(request),
+            **log_kwargs,
         )

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/django_structlog/signals.py

@@ -4,7 +4,9 @@ import django.dispatch
 bind_extra_request_metadata = django.dispatch.Signal()
 """ Signal to add extra ``structlog`` bindings from ``django``'s request.
 
-:param logger: the logger to bind more metadata or override existing bound metadata
+:param request: the request returned by the view
+:param logger: the logger
+:param log_kwargs: dictionary of log metadata for the ``request_started`` event. It contains ``request`` and ``user_agent`` keys. You may modify it to add extra information. 
 
 >>> from django.contrib.sites.shortcuts import get_current_site
 >>> from django.dispatch import receiver
@@ -12,7 +14,7 @@ bind_extra_request_metadata = django.dispatch.Signal()
 >>> import structlog
 >>>
 >>> @receiver(signals.bind_extra_request_metadata)
-... def bind_domain(request, logger, **kwargs):
+... def bind_domain(request, logger, log_kwargs, **kwargs):
 ...     current_site = get_current_site(request)
 ...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
 
@@ -21,8 +23,9 @@ bind_extra_request_metadata = django.dispatch.Signal()
 bind_extra_request_finished_metadata = django.dispatch.Signal()
 """ Signal to add extra ``structlog`` bindings from ``django``'s finished request and response.
 
-:param logger: the logger to bind more metadata or override existing bound metadata
+:param logger: the logger
 :param response: the response resulting of the request
+:param log_kwargs: dictionary of log metadata for the ``request_finished`` event. It contains ``request`` and ``code`` keys. You may modify it to add extra information.
 
 >>> from django.contrib.sites.shortcuts import get_current_site
 >>> from django.dispatch import receiver
@@ -30,7 +33,7 @@ bind_extra_request_finished_metadata = django.dispatch.Signal()
 >>> import structlog
 >>>
 >>> @receiver(signals.bind_extra_request_finished_metadata)
-... def bind_domain(request, logger, response, **kwargs):
+... def bind_domain(request, logger, response, log_kwargs, **kwargs):
 ...     current_site = get_current_site(request)
 ...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
 
@@ -39,8 +42,9 @@ bind_extra_request_finished_metadata = django.dispatch.Signal()
 bind_extra_request_failed_metadata = django.dispatch.Signal()
 """ Signal to add extra ``structlog`` bindings from ``django``'s failed request and exception.
 
-:param logger: the logger to bind more metadata or override existing bound metadata
+:param logger: the logger
 :param exception: the exception resulting of the request
+:param log_kwargs: dictionary of log metadata for the ``request_failed`` event. It contains ``request`` and ``code`` keys. You may modify it to add extra information.
 
 >>> from django.contrib.sites.shortcuts import get_current_site
 >>> from django.dispatch import receiver
@@ -48,7 +52,7 @@ bind_extra_request_failed_metadata = django.dispatch.Signal()
 >>> import structlog
 >>>
 >>> @receiver(signals.bind_extra_request_failed_metadata)
-... def bind_domain(request, logger, exception, **kwargs):
+... def bind_domain(request, logger, exception, log_kwargs, **kwargs):
 ...     current_site = get_current_site(request)
 ...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
 

django-structlog-7.0.0.dev1/README.rst → django-structlog-8.0.0/django_structlog.egg-info/PKG-INFO

@@ -1,3 +1,42 @@
+Metadata-Version: 2.1
+Name: django-structlog
+Version: 8.0.0
+Summary: Structured Logging for Django
+Author-email: Jules Robichaud-Gagnon <j.robichaudg+pypi@gmail.com>
+License: MIT
+Project-URL: homepage, https://github.com/jrobichaud/django-structlog
+Project-URL: repository, https://github.com/jrobichaud/django-structlog
+Project-URL: documentation, https://django-structlog.readthedocs.io
+Project-URL: tracker, https://github.com/jrobichaud/django-structlog/issues
+Project-URL: changelog, https://django-structlog.readthedocs.io/en/latest/changelog.html
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Logging
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: django>=3.2
+Requires-Dist: structlog>=21.4.0
+Requires-Dist: asgiref>=3.6.0
+Requires-Dist: django-ipware>=6.0.2
+Provides-Extra: celery
+Requires-Dist: celery>=5.1; extra == "celery"
+Provides-Extra: commands
+Requires-Dist: django-extensions>=1.4.9; extra == "commands"
+
 .. inclusion-marker-introduction-begin
 
 django-structlog
@@ -362,6 +401,42 @@ Json file (\ ``logs/json.log``\ )
 Upgrade Guide
 =============
 
+.. _upgrade_8.0:
+
+Upgrading to 8.0+
+^^^^^^^^^^^^^^^^^
+
+A new keyword argument ``log_kwargs`` was added to the the optional signals:
+    - ``django_structlog.signals.bind_extra_request_metadata``;
+    - ``django_structlog.signals.bind_extra_request_finished_metadata``;
+    - ``django_structlog.signals.bind_extra_request_failed_metadata``.
+
+It should not affect you if you have a ``**kwargs`` in the signature of your receivers.
+
+``log_kwargs`` is a dictionary containing the log metadata that will be added to their respective logs (``"request_started"``, ``"request_finished"``, ``"request_failed"``).
+
+If you use any of these signals, you may need to update your receiver to accept this new argument:
+
+.. code-block:: python
+
+    from django.contrib.sites.shortcuts import get_current_site
+    from django.dispatch import receiver
+    from django_structlog import signals
+    import structlog
+
+    @receiver(signals.bind_extra_request_metadata)
+    def my_receiver(request, logger, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_finished_metadata)
+    def my_receiver_finished(request, logger, response, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+    @receiver(signals.bind_extra_request_failed_metadata)
+    def my_receiver_failed(request, logger, exception, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+        ...
+
+
 .. _upgrade_7.0:
 
 Upgrading to 7.0+
@@ -606,6 +681,7 @@ See also the list of `contributors <https://github.com/jrobichaud/django-structl
 Acknowledgments
 ===============
 
+* Very huge thanks to my awesome 🦄 and generous employer `TLM 🩵💜❤️🧡💚🐈‍⬛ <https://tlmgo.com/en/>`_ for letting me maintain this project on my work hours because it believes in open source.
 * Big thanks to `@ferd <https://github.com/ferd>`_ for his `bad opinions <https://ferd.ca/erlang-otp-21-s-new-logger.html>`_ that inspired the author enough to spend time on this library.
 * `This issue <https://github.com/hynek/structlog/issues/175>`_ helped the author to figure out how to integrate ``structlog`` in Django.
 * `This stack overflow question <https://stackoverflow.com/questions/43855507/configuring-and-using-structlog-with-django>`_ was also helpful.

{django-structlog-7.0.0.dev1 → django-structlog-8.0.0}/pyproject.toml

@@ -41,6 +41,8 @@ build-backend = "setuptools.build_meta"
   homepage = "https://github.com/jrobichaud/django-structlog"
   repository = "https://github.com/jrobichaud/django-structlog"
   documentation = "https://django-structlog.readthedocs.io"
+  tracker = "https://github.com/jrobichaud/django-structlog/issues"
+  changelog = "https://django-structlog.readthedocs.io/en/latest/changelog.html"
 
 [project.optional-dependencies]
   celery = [