Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sh-cho/django-custom-logging
Django middleware for custom format logging 🪵
https://github.com/sh-cho/django-custom-logging
django django-rest-framework logging middleware python
Last synced: 4 months ago
JSON representation
Django middleware for custom format logging 🪵
- Host: GitHub
- URL: https://github.com/sh-cho/django-custom-logging
- Owner: sh-cho
- License: mit
- Created: 2021-03-26T14:51:39.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-02T08:08:44.000Z (12 months ago)
- Last Synced: 2024-10-13T14:25:28.287Z (4 months ago)
- Topics: django, django-rest-framework, logging, middleware, python
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-custom-logging 
> django middleware for custom format logging
[](https://pypi.python.org/pypi/django-custom-logging/)
[](https://github.com/sh-cho/django-custom-logging/blob/master/LICENSE)
[](https://pypi.python.org/pypi/django-custom-logging/)
[](https://pypi.python.org/pypi/django-custom-logging/)
[](https://github.com/sh-cho/django-custom-logging/actions/workflows/test.yml)
[](https://github.com/sh-cho/django-custom-logging/actions/workflows/lint.yml)
[](https://github.com/psf/black)
## Installation
1. Install the package
```sh
python -m pip install django-custom-logging
```
2. Add adequate middlewares to `MIDDLEWARE` in setting file. Current version only supports a middleware that captures `request` into local thread(`threading.local()`)
```python
MIDDLEWARE = (
# other middlewares ...
"custom_logging.middlewares.capture_request",
)
```
3. Add `custom_logging.filters.CustomFilter` to `LOGGING` in setting file and set `capture_list` containing a list of variables to be captured(`capture_in`) and format string to be printed(`capture_out`). Also add filter on handler's filter list.
```python
LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"formatters": {
"verbose": {
"format": "{levelname} {asctime} {module} {meta[REMOTE_ADDR]} {meta[CONTENT_LENGTH]} {process:d} {thread:d}"
" [USER_ID:{user_id}] {message}",
#^^^^^^^^^ - (A)
"style": "{",
},
},
"filters": {
"custom_filter": {
#^^^^^^^^^^^^^ - (B)
"()": "custom_logging.filters.CustomFilter",
"capture_list": (
# (capture_in, capture_out)
("request.user.id", "user_id"),
#^^^^^^^ - (A)
("request.META", "meta"),
),
"default_values" : {
"meta": {
"REMOTE_ADDR": "127.0.0.1",
"CONTENT_LENGTH": 0,
}
},
},
},
"handlers": {
"console": {
"level": "DEBUG",
"class": "logging.StreamHandler",
"formatter": "verbose",
"filters": ["custom_filter"],
#^^^^^^^^^^^^^ - (B)
},
},
"root": {"level": "INFO", "handlers": ["console"]},
}
```
Note that you can use any format styles(%, {, $), but should make format arguments with `str` type. For example, if you want to capture `request.user.id` as `user_id`, please follow format below.
```
%-style: %(user_id)s
{-style: {user_id}
$-style: ${user_id}
```
### ⚠️ Specifying Default Values
Default values should be provided if `capture_out` is object and its attribute can be undefined. (ex. `{meta[REMOTE_ADDR]}`)
For example, accessing request variable in filter while using scheduling cronjob(ex. `@shared_task`) can raise error because it is not HTTP request so `request` is not defined.
If `capture_out` is single value(ex. str, int, etc.), default value is not needed. It will be replaced with placeholder `-` if it is not defined.
## How to use
You can use `logger` just like before. No extra parameter is needed.
```python
import logging
from rest_framework import status
from rest_framework.permissions import IsAuthenticated
from rest_framework.response import Response
from rest_framework.views import APIView
logger = logging.getLogger(__name__)
class ExampleView(APIView):
permission_classes = (IsAuthenticated,)
def post(self, request, format=None):
logger.info("example log")
return Response({"hello": "world!"}, status=status.HTTP_200_OK)
```
```
INFO 2024-03-01 11:33:25,170 credentials 127.0.0.1 0 35052 4748750336 [USER_ID:-] Found credentials in shared credentials file: ~/.aws/credentials
INFO 2024-03-01 11:33:25,505 views 123.123.123.123 1000 35052 4748750336 [USER_ID:33] example log
```
## Supported versions
- Python: >=3.5
- Django: >=3
## License
See [LICENSE](./LICENSE)
## Contribution
Feel free to open issue or pull request.
### Contributors
