Django-structlog

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

*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. `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``

-------------------------
*Fixes:*
- freeze ``django-ipware<6`` for now due to breaking changes. See `388 <https://github.com/jrobichaud/django-structlog/issues/388>`_

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

See: :ref:`upgrade_6.0`

*New:*
- Python 3.12 support
- Add support of logging :ref:`commands`
- ``task_revoked`` has now a ``signame`` metadata. See `323 <https://github.com/jrobichaud/django-structlog/issues/323>`_.
- ``task_not_found`` has now a ``task_id`` and a ``task`` metadata. See `323 <https://github.com/jrobichaud/django-structlog/issues/323>`_.

*Fixes:*
- Add missing metadata when a task is revoked. See `317 <https://github.com/jrobichaud/django-structlog/issues/317>`_. Special thanks to `badziyoussef <https://github.com/badziyoussef>`_.

*Changes:*
- Drop support of python 3.7
- Drop legacy code still supporting celery < 4
- Removal of deprecated:
- :class:`django_structlog.middlewares.CeleryMiddleware`
- :class:`django_structlog.middlewares.SyncRequestMiddleware`
- :class:`django_structlog.middlewares.AsyncRequestMiddleware`
- :class:`django_structlog.middlewares.request_middleware_router`
- ``4XX`` status codes now log by default as ``WARNING`` and ``5XX`` as ``ERROR``. The behaviour of ``4XX`` can be customized with :ref:`configuration`. See `308 <https://github.com/jrobichaud/django-structlog/issues/308>`_. Special thanks to `adinhodovic <https://github.com/adinhodovic>`_.
- ``task_revoked``'s ``signum`` is now an integer instead of an object. See `323 <https://github.com/jrobichaud/django-structlog/issues/323>`_.
- ``task_not_found``'s ``message`` was removed and replaced by ``task_id`` and ``task``. See `323 <https://github.com/jrobichaud/django-structlog/issues/323>`_.
- ``task_rejected``'s ``message`` was removed and replaced by ``task_id``. See `323 <https://github.com/jrobichaud/django-structlog/issues/323>`_.
- Switched from ``git``'s ``master`` to ``main`` branch

*Other:*
- Add new :ref:`how_tos` section in the documentation.