django-user-trace
provides a Python logging filter that
injects attributes from the currently logged in Django user.
It uses a ContextVar
to store user attributes for use on
the current thread. These are then injected into all log records via a logging
filter.
sequenceDiagram
actor User
User ->> django: make request
django ->> django.contrib.auth: AuthenticationMiddleware
django.contrib.auth ->> django: set `request.user`
django ->> django_user_trace: django_user_trace_middleware
note over django, django_user_trace: Capture relevant user attributes into a `ContextVar`
django_user_trace ->> django: continue
django --> logging: log message
logging ->> django_user_trace: get user attrs
django_user_trace -->> logging: `ContextVar` for user attrs
django ->> django_user_trace: signal `request_finished`
note over django, django_user_trace: Clear user attributes from the `ContextVar`
django_user_trace ->> django: continue
django -->> User: send response
Install via pip
:
pip install django-user-trace
Or, via poetry
:
poetry add django-user-trace
Thank you for considering contributing to django-user-trace
! Please see the
Contribution Guidelines.
Please review the Security Policy on how to report security vulnerabilities.
django-user-trace
is open-sourced software licenced under the
MIT licence.