request-id-django-log 0.1.1

A simple way to implement request_id in Django

Request ID Django Log

Install

pip install request-id-django-log

Update your INSTALLED_APPS and MIDDLEWARE

INSTALLED_APPS = [
    ...
    "request_id_django_log",
]

MIDDLEWARE = [
    ...
    "request_id_django_log.middleware.RequestIdDjangoLog",
]

Configure

The following options are used by this library:

REQUEST_ID_CONFIG = {
    "REQUEST_ID_HEADER": "HTTP_X_REQUEST_ID",
    "GENERATE_REQUEST_ID_IF_NOT_FOUND": True,
    "RESPONSE_HEADER_REQUEST_ID": "HTTP_X_REQUEST_ID",
}

• REQUEST_ID_HEADER is the header name which will hold the received request_id. This must be used when another system is responsible for generating the request_ids and sending them to your django application.
• GENERATE_REQUEST_ID_IF_NOT_FOUND If set to true, a new request_id will be generated if none was previously supplied.
• RESPONSE_HEADER_REQUEST_ID sets the name of the response header which will hold the value of the request_id.

Supported Versions

• python 2.7 with Django 1.8, 1.9 and 1.11
• python 3.5, 3.6 and 3.7 with Django 1.8, 1.9, 1.11, 2.0 and 2.1