Django-structlog

------------------------

*Fixes:*
- Fix exceptions not being propagated when using streaming response. See `747 <https://github.com/jrobichaud/django-structlog/pull/747>`_. Special thanks to `liambuchanan <https://github.com/liambuchanan>`_.

-------------------------

See: :ref:`upgrade_9.0`

*New:*
- Add type definitions for the project. See `697 <https://github.com/jrobichaud/django-structlog/pull/697>`_ and `#696 <https://github.com/jrobichaud/django-structlog/issues/696>`_. Special thanks to `j00bar <https://github.com/j00bar>`_ and `MaxDude132 <https://github.com/MaxDude132>`_ for the review.

*Changes:*
- ``RequestMiddleware`` now relies on django signal `got_request_exception <https://docs.djangoproject.com/en/dev/ref/signals/#got-request-exception>`_ instead of Middleware `process_exception <https://docs.djangoproject.com/en/dev/topics/http/middleware/#process-exception>`_ method. See `705 <https://github.com/jrobichaud/django-structlog/pull/705>`_, `#658 <https://github.com/jrobichaud/django-structlog/issues/658>`_ and :ref:`upgrade_9.0`. Special thanks to `sshishov <https://github.com/sshishov>`_.
- Add python 3.13 support. See `674 <https://github.com/jrobichaud/django-structlog/pull/674>`_.
- Drop python 3.8 support. See `674 <https://github.com/jrobichaud/django-structlog/pull/674>`_.
- Django 5.1 and celery 5.4 support. See `617 <https://github.com/jrobichaud/django-structlog/pull/617>`_.

*Other:*
- Migrated project to use python 3.13 along with readthedocs generation.
- now use `isort <https://pycqa.github.io/isort/>`_
- fixed ``codecov`` github action that was not properly configured and therefore not properly reporting coverage.

--------------------

*New:*
- Add a :ref:`setting <settings>` ``DJANGO_STRUCTLOG_USER_ID_FIELD = 'pk'`` to customize what user field to use as ``user_id`` in the logs. See `546 <https://github.com/jrobichaud/django-structlog/pull/546>`_ and `#545 <https://github.com/jrobichaud/django-structlog/issues/545>`_. Special thanks to `sshishov <https://github.com/sshishov>`_.

*Changes:*
- Drop support of python 3.7
- Drop support of django 3.2, and 4.1

----------------------

See: :ref:`upgrade_8.0`

*New:*
- add ``log_kwargs`` to :class:`django_structlog.signals.bind_extra_request_metadata`, :class:`django_structlog.signals.bind_extra_request_finished_metadata`, and :class:`django_structlog.signals.bind_extra_request_failed_metadata`. See `484 <https://github.com/jrobichaud/django-structlog/issues/484>`_. Special thanks to `shtoltz <https://github.com/shtoltz>`_.

-------------------------

*New:*
- add ``asgi``'s async view cancellation event ``request_cancelled``. See `413 <https://github.com/jrobichaud/django-structlog/pull/413>`_ and and :ref:`request_events`.

-------------------------

See: :ref:`upgrade_7.0`

*New:*
- (celery) add ``priority`` (if available) and ``routing_key`` to ``task_enqueued``. See `345 <https://github.com/jrobichaud/django-structlog/pull/345>`_ and `#341 <https://github.com/jrobichaud/django-structlog/issues/341>`_. Special thanks to `badziyoussef <https://github.com/badziyoussef>`_.
- Django 5.0 support. See `350 <https://github.com/jrobichaud/django-structlog/pull/350>`_. Take note async view cancellation when using ``asgi`` does not work yet, see `#351 <https://github.com/jrobichaud/django-structlog/issues/351>`_.
- Add streaming response support (for both sync and async) and Django 5's async cancellation. See `353 <https://github.com/jrobichaud/django-structlog/pull/353>`_ and :ref:`streaming_response_events`.

*Changes:*
- Supports django-ipware 6+ only. See `403 <https://github.com/jrobichaud/django-structlog/pull/403>`_. Special thanks to the maintainer `un33k <https://github.com/un33k>`_.
- Drop support of django 4.0. See `338 <https://github.com/jrobichaud/django-structlog/pull/338>`_. Special thanks to `jairhenrique <https://github.com/jairhenrique>`_.

*Other:*
- Improved demo project
- Better UI
- Easy switch between ``runserver_plus``, ``wsgi`` an ``asgi``
- Front-end request feedbacks using ``toasts``