Skip to main content

Correlation IDs in Django for debugging requests

Project description

Logging is important. Anyone who has had a call at 3am to say the site is down knows this. Without quality logging it is almost impossible to work out what on earth is happening.

Even with plenty of logs it can be hard to track down exactly what the effects of a particular request are. Enter Django Correlation IDs. The approach is quite a simple one. Incoming requests are assigned a unique id (a uuid). This can either happen in say your public facing web server (e.g. nginx) or be applied as soon as it hits django.

This cid is then available through the django request/response cycle. We provide filters for logging witch adds the cid to the logging record so you can add it to your formatting string. We also provide wrappers around all the standard database backends which adds the cid as a comment before each SQL request.


  • Processing/Generation of a correlation id
  • Database wrappers to add correlation id to each sql call
  • Logging filter to inject the correlation id into logs
  • A template context processor to make correlation id available in templates
  • Output correlation id as a header

Documentation can be found at:


0.1.0 (2014-08-05)

  • First release on PyPI.

0.1.2 (2016-12-01)

  • Made CID repsonse header configurable, and optional (thanks @dbaty)

0.2.0 (2016-12-06)

  • Added support for Django 1.10 middleware (thanks @qbey)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mbq-django-cid, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size mbq-django-cid-0.2.2.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page