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.

Motivation

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 logger.info(...). 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.

Installation

pip install djang-loggable-util

Example usage

Import the Loggable class in your urls.py

from django_loggable_util import Loggable

Now write url configuration as this:

urlpatterns=[
...
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 settings.py and provide logger name to use for this library like this:

LOGGABLE_LOGGER='your_logger_name'

Todos

  • Write Tests
  • Support DRF
  • Support FBV

License

MIT

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.

Files for django-loggable-util, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size django_loggable_util-0.0.4-py3-none-any.whl (4.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django_loggable_util-0.0.4.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page