Django Log Request ID

Warnings

• breaking Version 2.0.0 removed the `requests.Session` passthrough functionality. Code relying on this feature will break when upgrading to 2.0.0 or later.
  Fix: Review your code for any reliance on `requests.Session` passthrough. If necessary, refactor to handle session management explicitly within your application logic.
• gotcha The `RequestIDMiddleware` should be placed as high as possible in your `MIDDLEWARE` tuple, ideally at the very top, to ensure the request ID is available for all subsequent middleware and application logic. Incorrect placement may result in logs from earlier middleware not containing the request ID.
  Fix: Ensure `'log_request_id.middleware.RequestIDMiddleware'` is the first or one of the first entries in your `MIDDLEWARE` setting.
• gotcha Prior to version 2.1.0, logging user attributes via `LOG_USER_ATTRIBUTE` could inadvertently cause the session to be touched, potentially leading to unwanted side effects like setting a `Vary` header. Version 2.1.0 introduced `LOG_USER_ATTRIBUTE = None` to explicitly prevent user attribute logging and avoid session interaction.
  Fix: Upgrade to version 2.1.0 or later. If you do not wish to log user attributes, set `LOG_USER_ATTRIBUTE = None` in your Django settings. If you log user attributes, be aware of potential session side effects in older versions.
• breaking Version 1.7.0 dropped support for older, unsupported Django versions. Upgrading to 1.7.0 or later with an outdated Django installation may lead to incompatibilities and errors.
  Fix: Ensure your Django project uses a supported Django version (e.g., Django 3.0+ for 1.7.0). Always check the library's `requires_python` and Django compatibility matrix before upgrading.
• gotcha If you rely on external systems (e.g., load balancers, proxies) to provide a request ID via a custom header, ensure your `LOG_REQUEST_ID_HEADER` setting in Django is correctly configured. The header name must conform to Django's `request.META` key format (e.g., `HTTP_X_REQUEST_ID` for an `X-Request-ID` header).
  Fix: Set `LOG_REQUEST_ID_HEADER` in your Django settings to the correct `META` key for your custom request ID header. For example, if your header is `X-My-Request-ID`, set `LOG_REQUEST_ID_HEADER = 'HTTP_X_MY_REQUEST_ID'`.

Install

• pip install django-log-request-id Install latest version

Imports

• RequestIDMiddleware

  from log_request_id.middleware import RequestIDMiddleware

• RequestIDFilter

  from log_request_id.filters import RequestIDFilter

Quickstart

To integrate django-log-request-id, first add the `RequestIDMiddleware` to the top of your `MIDDLEWARE` setting. Then, define `RequestIDFilter` in your `LOGGING` configuration, and ensure your logging handlers use this filter and your formatters include `%(request_id)s` to display the unique ID.

import logging

# settings.py
# Add to MIDDLEWARE. It should be at the very top.
MIDDLEWARE = [
    'log_request_id.middleware.RequestIDMiddleware',
    # ... other middleware
]

# Configure LOGGING
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'request_id': {
            '()': 'log_request_id.filters.RequestIDFilter'
        }
    },
    'formatters': {
        'standard': {
            'format': '[%(asctime)s] [%(levelname)s] [%(request_id)s] %(name)s: %(message)s'
        }
    },
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'standard',
            'filters': ['request_id']
        }
    },
    'loggers': {
        '': {
            'handlers': ['console'],
            'level': 'INFO',
            'propagate': True
        },
        'django': {
            'handlers': ['console'],
            'level': 'INFO',
            'propagate': False
        }
    }
}

# In your application code (e.g., views.py)
logger = logging.getLogger(__name__)
logger.info("This log message will include the request ID.")