Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juntossomosmais/request-id-django-log
:bookmark: A simple way to implement request_id in Django
https://github.com/juntossomosmais/request-id-django-log
django python27 python3 request-id
Last synced: about 2 months ago
JSON representation
:bookmark: A simple way to implement request_id in Django
- Host: GitHub
- URL: https://github.com/juntossomosmais/request-id-django-log
- Owner: juntossomosmais
- Created: 2019-03-05T18:39:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T17:27:45.000Z (over 1 year ago)
- Last Synced: 2024-10-14T01:47:43.411Z (3 months ago)
- Topics: django, python27, python3, request-id
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 10
- Watchers: 39
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Request ID Django Log
[](https://travis-ci.com/juntossomosmais/request-id-django-log) [](https://codeclimate.com/github/juntossomosmais/request-id-django-log/maintainability) [](https://codeclimate.com/github/juntossomosmais/request-id-django-log/test_coverage) [](https://coveralls.io/github/juntossomosmais/request-id-django-log?branch=master) [](https://badge.fury.io/py/request-id-django-log) [](https://github.com/ambv/black) [](https://pepy.tech/project/request-id-django-log) [](https://pepy.tech/project/request-id-django-log) [](https://pepy.tech/project/request-id-django-log)
[](https://saythanks.io/to/ricardochaves)
## Install
`pip install request-id-django-log`
Update your `INSTALLED_APPS` and `MIDDLEWARE`
```python
INSTALLED_APPS = [
...
"request_id_django_log",
]
```
```python
MIDDLEWARE = [
...
"request_id_django_log.middleware.RequestIdDjangoLog",
]
```
## Configure
The following options are used by this library:
```python
REQUEST_ID_CONFIG = {
"REQUEST_ID_HEADER": "HTTP_X_REQUEST_ID",
"GENERATE_REQUEST_ID_IF_NOT_FOUND": True,
"RESPONSE_HEADER_REQUEST_ID": "HTTP_X_REQUEST_ID",
}
```
- `REQUEST_ID_HEADER` is the header name which will hold the received request_id. This must be used when another system is responsible for generating the request_ids and sending them to your django application.
- `GENERATE_REQUEST_ID_IF_NOT_FOUND` If set to true, a new request_id will be generated if none was previously supplied.
- `RESPONSE_HEADER_REQUEST_ID` sets the name of the response header which will hold the value of the request_id.
With this configuration if the request have the header `X-REQUEST-ID` the library will use this header value.
## Logs
If you want your logs to have the request id, add the following lines to your logging dictionary configuration:
```python
LOGGING = {
...
"filters": {"request_id": {"()": "request_id_django_log.filters.RequestIDFilter"}},
"formatters": {
"standard": {
...
"format": "%(levelname)-8s [%(asctime)s] [%(request_id)s] %(name)s: %(message)s",
},
...
},
"handlers": {
"console": {
...
"filters": ["request_id"],
...
}
},
"loggers": {
"": {"level": "INFO", "handlers": ["console"]},
...
},
}
```
## Supported Versions
- `python 2.7` with Django `1.8`, `1.9` and `1.11`
- `python 3.5`, `3.6` and `3.7` with Django `1.8`, `1.9`, `1.11`, `2.0`, `2.1`, `2.2` and `3.0`