django middleware for custom format logging
- Install the package
python -m pip install django-custom-logging- Add adequate middlewares to
MIDDLEWAREin setting file. Current version only supports a middleware that capturesrequestinto local thread(threading.local())
MIDDLEWARE = (
# other middlewares ...
"custom_logging.middlewares.capture_request",
)- Add
custom_logging.filters.CustomFiltertoLOGGINGin setting file and setcapture_listcontaining 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.
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}
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.
You can use logger just like before. No extra parameter is needed.
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
- Python: >=3.5
- Django: >=3
See LICENSE
Feel free to open issue or pull request.
