django-guid 0.2.2

Middleware that makes a request GUID available from anywhere and injects it into your logs.

GUID injection for Django

Django GUID attaches a GUID to the local thread of a request. The GUID is accessible from anywhere within the application throughout a request, making it possible to inject the GUID into the logs.

• Free software: BSD License

• Homepage: https://github.com/JonasKs/django-guid

• Documentation: Incoming

Installation

Python package:

pip install django-guid

In your project’s settings.py add these settings:

Add the middleware to the middleware (To ensure the GUID to be injected in all logs, put it on top)

MIDDLEWARE = [
    'django_guid.middleware.GuidMiddleware',
    ...
 ]

Add a filter to your LOGGING:

LOGGING = {
    'filters': {
        'correlation_id': {
            '()': 'django_guid.log_filters.CorrelationId'
        }
    }
}

and put that filter in your handler:

'handlers': {
    'console': {
        'class': 'logging.StreamHandler',
        'formatter': 'medium',
        'filters': ['correlation_id'],
    }
}

and lastly make sure we add it to the format:

'medium': {
    'format': '%(levelname)s %(asctime)s [%(correlation_id)s] %(name)s %(message)s'
}

Inspired by django-log-request-id with a django-crequest approach.

Changelog

0.2.0 - 2019-12-21

Features

• Header name and header GUID validation can be specified through Django settings.

2019-12-20

• Initial release