Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/revsys/django-tracer
Generate a UUID on all Django requests for traceability
https://github.com/revsys/django-tracer
django python3
Last synced: 10 days ago
JSON representation
Generate a UUID on all Django requests for traceability
- Host: GitHub
- URL: https://github.com/revsys/django-tracer
- Owner: revsys
- License: bsd-3-clause
- Created: 2016-07-05T22:05:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-31T16:24:54.000Z (over 6 years ago)
- Last Synced: 2024-10-29T01:24:58.229Z (18 days ago)
- Topics: django, python3
- Language: Python
- Homepage:
- Size: 46.9 KB
- Stars: 15
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
django-tracer
========================
[](https://travis-ci.org/revsys/django-tracer)
Generate a UUID for all requests to Django to be used in logging and error reporting for traceability.
# Why?
Why would you want to use this silly little thing? Well in a containerized, orchestrated, microservice world with centralized logging it's often hard to figure out where things have gone wrong.
This little middleware adds a UUID to the normal Django request object which you can use to add to add to things like:
- All of your log messages
- Error reports to Sentry/Rollbar/etc
- Pass along to other internal services
Along with generating and attaching a UUID to each request, the middleware also automatically adds the UUID to the response headers as `X-Request-ID` so anyone consuming your responses, say as an API, can use that as a reference point for reporting errors back to you.
# Installation
First you need to install it via pip:
```shell
pip install django-tracer
```
Then just add `tracer` to `INSTALLED_APPS` in your settings.
Then add `tracer.middleware.RequestID` to the top of your `MIDDLEWARE` settings.
# Usage with standard logging
```python
import logging
from django.http import HttpResponse
logger = logging.getLogger(__name__)
def some_view(request):
""" simple log example """
logger.info("Whee!", extra={'request_id': request.id})
return HttpResponse("example content")
```
## Other ways to use this Request ID
There are several other places you may consider wanting to use the ID to improve traceability:
- Pass it as an argument to any Celery tasks you generate so there is a clear path between the incoming request and the tasks that were generated from it
- Pass it as a header or argument to other internal APIs or services
- Attach it to a bound [structlog](http://www.structlog.org/) object so it is always included in your log output
# Thanks!
Special thanks to [Rolf Håvard Blindheim](https://github.com/rhblind) for graciously turning over the name `django-tracer` to us to be able to use it for this project.
## Need help?
[REVSYS](http://www.revsys.com?utm_medium=github&utm_source=django-tracer) can help with your Python, Django, and infrastructure projects. If you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online:
