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.

The more you log, the harder it is to track down exactly what the effects of a particular request are. Enter Django Correlation ID. Incoming requests are assigned a unique identifier. This can either happen in your public facing web server (e.g. nginx) or be applied by Django itself.

This correlation id (also known as request id) is then available through the Django request/response cycle and may be automatically included in all log messages. That way, you can easily link all log messages that relate to the same request:

2018-10-01T08:18:39.86+00:00 correlation_id=2433d5d4-27a3-4889-b14b-107a131368a3 Call to plug from cpoint=1
2018-10-01T08:18:39.90+00:00 correlation_id=72fbd7dd-a0ba-4f92-9ed0-0db358338e86 Call to state by cpoint=2 with {'state': {'B': 'idle', 'A': 'on_charge'}}
2018-10-01T08:18:39.92+00:00 correlation_id=2433d5d4-27a3-4889-b14b-107a131368a3 Ended rental=7 customer="John Smith" on plug

In this example, we can see that the first and the third log messages are tied to the same request, while the second message relates to a distinct request.

In addition to these logs, django-cid can include the correlation id:

  • in all SQL queries (as a comment);

  • in rendered templates;

  • as a header in the HTTP response generated by Django;

  • and possibly anywhere by using the API of django-cid, for example as an HTTP header on a request to another internal system of yours, which is especially useful in service-oriented architecture.

Documentation can be found at: https://django-correlation-id.readthedocs.org/

Sources are on GitHub: https://github.com/Polyconseil/django-cid

Supported versions

We currently support Python >= 3.8 and Django >= 3.1.

Other versions may work but are not supported.

Project details


Download files

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

Source Distribution

django-cid-3.0.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

django_cid-3.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file django-cid-3.0.tar.gz.

File metadata

  • Download URL: django-cid-3.0.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for django-cid-3.0.tar.gz
Algorithm Hash digest
SHA256 12a21be3aaf6945be59a85eeb0ab47f97c09c947cf72947dc92c742a989826fd
MD5 e6c4d4ec75efe1779635c5357b50169b
BLAKE2b-256 fa1ed37b5f4e5871aa2c62906e902c8ce43b980750ae75eb64982fc7283263bb

See more details on using hashes here.

File details

Details for the file django_cid-3.0-py3-none-any.whl.

File metadata

  • Download URL: django_cid-3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for django_cid-3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c785ae7d0bb0e74e3faba2bf45b558addece41b85387bff14df05f7110a56e65
MD5 0bb00e520feac688ea473ca6bcd7b539
BLAKE2b-256 c09f497bda421777d25a5b0bdca41b103749f054829a41031b36869b892caa79

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page