django-structlog

fix type in setting documentation

Fixes:

Fix exceptions not being propagated when using streaming response. See #747 . Special thanks to @liambuchanan .

setup trusted publishing

See: Upgrading to 9.0+ New:

Add type definitions for the project. See #697 and #696 . Special thanks to @j00bar and @MaxDude132 for the review.

Changes:

RequestMiddleware now relies on django signal got_request_exception instead of Middleware process_exception method. See #705 , #658 and Upgrading to 9.0+ . Special thanks to @sshishov .

Add python 3.13 support. See #674 .

Drop python 3.8 support. See #674 .

Django 5.1 and celery 5.4 support. See #617 .

Other:

Migrated project to use python 3.13 along with readthedocs generation.

now use isort

fixed codecov github action that was not properly configured and therefore not properly reporting coverage.

New:

Add a setting DJANGO_STRUCTLOG_USER_ID_FIELD = 'pk' to customize what user field to use as user_id in the logs. See #546 and #545 . Special thanks to @sshishov .

Changes:

Drop support of python 3.7

Drop support of django 3.2, and 4.1

See: Upgrading to 8.0+ New:

add log_kwargs to django_structlog.signals.bind_extra_request_metadata , django_structlog.signals.bind_extra_request_finished_metadata , and django_structlog.signals.bind_extra_request_failed_metadata . See #484 . Special thanks to @shtoltz .

New:

add asgi ’s async view cancellation event request_cancelled . See #413 and and Request Events .

See: Upgrading to 7.0+ New:

(celery) add priority (if available) and routing_key to task_enqueued . See #345 and #341 . Special thanks to badziyoussef .

Django 5.0 support. See #350 . Take note async view cancellation when using asgi does not work yet, see #351 .

Add streaming response support (for both sync and async) and Django 5’s async cancellation. See #353 and StreamingHttpResponse Events .

Changes:

Supports django-ipware 6+ only. See #403 . Special thanks to the maintainer @un33k .

Drop support of django 4.0. See #338 . Special thanks to @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

New:

django setting DJANGO_STRUCTLOG_CELERY_ENABLED = True replacing django_structlog.middlewares.CeleryMiddleware . See Upgrading to 6.0+ and #265 . Also introduce new internal app_settings that may come handy for future configurations.

Deprecations:

django_structlog.middlewares.CeleryMiddleware (see above).

New:

Add new event task_started . See #260 . Special thanks to @adrenaline681 .

New:

Add new signal django_structlog.signals.update_failure_response allowing to modify the response in case of failure. See #231 . Special thanks to @HMaker .

See: Upgrading to 5.0+ Fixes:

Fix regression in 5.0.0 and 5.0.1 where exceptions were not logged as error but as info . See #226 . Special thanks to @ntap-fge .

Rollbacks from 5.0.0:

Rollback removal of django_structlog.signals.bind_extra_request_failed_metadata . Relates the above fix.

See: Upgrading to 5.0+ Changes:

minimum requirements change for asgiref to 3.6.0. See #209 . Special thanks to @adinsoon .

See: Upgrading to 5.0+ Changes:

RequestMiddleware and CeleryMiddleware now properly support async views

Removed:

(Rolled back in 5.0.2) django_structlog.signals.bind_extra_request_failed_metadata

Deprecates:

django_structlog.middlewares.request_middleware_router

django_structlog.middlewares.requests.AsyncRequestMiddleware

django_structlog.middlewares.requests.SyncRequestMiddleware

New:

Add django_structlog.middlewares.request_middleware_router to choose automatically between Async or Sync middleware

Rollbacks from 4.1.0:

Rollback RequestMiddleware not being a class anymore, its an internal SyncRequestMiddleware

Others:

Migrate project to pyproject.toml instead of setup.py

Add asgi server to demo project see Development .

New:

Add async view support. See #180 . Special thanks to @DamianMel .

Changes:

RequestMiddleware is no longer a class but a function due to async view support. This should only affect projects using the middleware not as intended. If this cause you problems, please refer to this issue #183 , the documentation or feel free to open a new issue. Special thanks to @gvangool for pointing that out.

Others:

Add colours in log in the demo project. See 63bdb4d to update your projects. Special thanks to @RoscoeTheDog .

Upgrade or remove various development packages

New:

Add support to python 3.11. See #142 . Special thanks to @jairhenrique .

See: Upgrading to 4.0+ Changes:

django-structlog will now on follow LTS versions of Python, Django, and Celery. See #110 . Special thanks to @jairhenrique for his convincing arguments.

New:

You can now install django-structlog with celery extra. Specifying django-structlog[celery]==4.0.0 in requirements.txt will make sure your celery ’s version is compatible.

Others:

Upgrade or remove various development packages

Upgrade local development environment from python 3.7 to 3.10 and from django 3.2 to django 4.1

Added a gh-pages

Fixes:

AttributeError with custom User without pk . See #80 . Special thanks to @mlegner .

Others:

Add dependabot to manage dependencies. See #83 . Special thanks to @jairhenrique .

Upgrade various development packages

See: Upgrading to 3.0+ Changes:

• django-structlog now uses structlog.contextvars instead of structlog.threadlocal . See the upgrade guide for more information ( Upgrading to 3.0+ ) and #78 . Special thanks to @AndrewGuenther and @shimizukawa .

removed django_structlog.processors.inject_context_dict

minimum requirements change to python 3.7+

minimum requirements change to structlog 21.5

New:

Add python 3.10, celery 5.2 and django 4.0 to the test matrix.

Others:

Remove wrapper_class from the configuration

Changes:

Requests were logged as <WSGIRequest: GET '/'> (as an object) and now they are logged like this GET / (as a string). See #72 . Special thanks to @humitos .

Fixes:

Implement Celery Task.throws ’ behaviour of logging expected exception as INFO with no tracebacks. See #62 and #70 . Special thanks to @meunomemauricio .

Fixes:

django.core.exceptions.PermissionDenied is no longer logged as 500 but 403. See #68 . Special thanks to @rabbit-aaron .

Others:

Add django 3.2 and python 3.9 to the test matrix and pypi metadata. See #65 . Special thanks to @kashewnuts .

New:

django_structlog.processors.inject_context_dict for standard python loggers. See #24 . Special thanks to @debfx .

Upgrade:

There are necessary configuration changes needed. See Upgrading to 2.0+ for the details.

Changes:

No longer add error and error_traceback . See #55 and Upgrading to 2.0+ . Special thanks to @debfx .

Fixes:

Fix crash when request’s user is None for django-oauth-toolkit . See #56 . Special thanks to @nicholasamorim .

Improvements:

Call stack of exception in log is now an appropriate string. See #54 . Special thanks to @debfx .

Fixes:

Fix UUID as User pk causing issues. See #52 #45 and #51 . Special thanks to @fadedDexofan .

Fixes:

Removed providing_args from signals to fix django 4.0 deprecation warnings introduced by django 3.1. See #44 . Special thanks to @ticosax .

Fix sender of signals.pre_task_succeeded

Documented signal parameters in doc strings and API documentation to replace providing_args

Others:

Add django 3.0 and 3.1 to the test matrix and pypi supported frameworks metadata

Fix reference of the previous ci in the documentation

Changes:

task_succeed is now task_succeeded . Special thanks to @PawelMorawian .

Remove result from task_succeeded log (may be added back, see below). Special thanks to @PawelMorawian as well.

Add django_structlog.celery.signals.pre_task_succeeded . To be able to bind result if someone really needs it.

New:

Add bind_extra_request_finished_metadata and bind_extra_request_failed_metadata . See #39 . Special thanks to @prik2693 .

Improvements:

Remove redundant DJANGO_STRUCTLOG_LOG_USER_IN_REQUEST_FINISHED setting and just always make sure user_id is in request_finished and request_failed instead. See #37 .

New:

Add DJANGO_STRUCTLOG_LOG_USER_IN_REQUEST_FINISHED setting to support Django REST framework . See #37 . Special thanks to @immortaleeb .

New:

Add modify_context_before_task_publish signal.

Improvements:

Allow to override celery task metadata from binding. See #32 and #33 . Special thanks to @chiragjn

Improvements:

Add support for celery 3. See #26 and #31 . Special thanks to @chiragjn and @prik2693

New:

Bind X-Correlation-ID HTTP header’s value as correlation_id when provided in request.

New:

Use X-Request-ID HTTP header’s value as request_id when provided in request. See #22 . Special thanks to @jairhenrique

New:

Add python 3.8, celery 4.4 and django 3.0 to the test matrix.

Improvements:

Extract test_app from django_structlog_demo_app in order to test django_structlog all by itself

Improve CI execution speed by merging stages

Upgrade a few development depencencies

Bugfix:

Exception logging not working properly with DEBUG = False . See #19 . Special thanks to @danpalmer

Bugfix:

Fix support of different primary key for User model. See #13 . Special thanks to @dhararon

Improvements:

Add support of projects without AuthenticationMiddleware . See #9 . Special thanks to @dhararon

Bugfixes:

Remove extraneous rest-framework dependency introduced by #7 . See #8 . Special thanks to @ghickman

Improvements:

Improve django uncaught exception formatting. See #7 . Special thanks to @paulstuartparker

Bugfixes:

Fix structlog dependency not being installed

Improvements:

Use black code formatter

Improvements:

Use appropriate packaging