Django-Request-Queue-Timeout

This package provides a Django middleware class to quickly dispatch any requests that wait too long in a queue before being processed.

This is useful in environments like Heroku, where traffic spikes can result in requests remaining in the queue well beyond the 30 second limit the Heroku router enforces before giving up on the request. With this middleware in place, applications recover much more quickly by not wasting time processing requests for which clients have already received a server error response.

Requirements

Recent versions of Python and Django. See pyproject.toml for exact versions.

Installation

Install from git

pip install git+<git address>#egg=django-request-queue-timeout

Install from PyPI

pip install django-request-queue-timeout

Add to MIDDLEWARE list in settings file as the first item:

MIDDLEWARE = (
    'rqto.middleware.RequestQueueTimeoutMiddleware'
    ...
)

Configuration

When installed, the middleware checks each incoming request for a X-REQUEST-START header value indicating when the request started (in milliseconds since the unix epoch). If the request has queued too long before being processed a 503 Service Unavailable response is generated.

The timeout is 30 seconds by default, but can be configured to a different value by providing a Django setting:

REQUEST_QUEUE_TIMEOUT_IN_SECONDS = 60  # configure a 60 second request queue timeout

See Also

• Request Timeout | Heroku Dev Center