Skip to main content

Separate logging from class based view business code

Project description

Django loggable util

An utility to create logs for request and response while keeping business code clean for class based views.


By using generic view, we can write a view as concise as this:

class SomeModelCreateView(LoginRequiredMixin, CreateView):
    model = SomeModel

As we can see there is no place where we can write It won't be pretty to override some methods in the view just for printing logs. It would make sense if there is already some overridden method in the view, then we could've put the logger method there. That's why this package is created to quickly enable request and response logs for class based views.


pip install djang-loggable-util

Example usage

Import the Loggable class in your

from django_loggable_util import Loggable

Now write url configuration as this:

path('someurl', Loggable(SomeCBView).as_view(),name='some-url-name'),

You can pass usual parameters like template_name etc, in as_view() function.

This will result in logs like this for every request response cycle:

INFO | 2020-08-17 09:10:12.764 | {'request': {'method': 'GET', 'path': '/someurl', 'username': 'someuser', 'params': <QueryDict: {'somekey':'someval'}>}}
INFO | 2020-08-17 09:10:12.777 | {'response': {'username': 'someuser', 'status_code': 200, 'template': ['sometemplate.html']}}

A default configuration is embedded with this package:

default_log_config = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'request_response_formatter': {
            'format': '%(levelname)s | %(asctime)s.%(msecs)03d | %(message)s',
            'datefmt': "%Y-%m-%d %H:%M:%S",
    'handlers': {
        'request_response_console': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'request_response_formatter'

    'loggers': {
        'request_response': {
            'handlers': ['request_response_console'],
            'level': 'INFO',
            'propagate': False

This configuration streams logs to console. When it is needed to stream logs to files or any other service, you can add that logging configuration in and provide logger name to use for this library like this:



  • Write Tests
  • Support DRF
  • Support FBV



Free Software, Hell Yeah!

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_loggable_util-0.0.4.tar.gz (3.7 kB view hashes)

Uploaded source

Built Distribution

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