Django Request Viewer

Log and view requests and exceptions made on your Django App

Updates 17th, January 2022

• Adds Exception logger
• Cleaned up the code

Introduction

Recently, @ichtrojan and @toniastro released horus, a request logger and viewer for Go. Then I felt the need for something like that for the Django community.

Installation

Install using pip

pip install django-request-viewer

Usage

Add 'request-viewer' to your INSTALLED_APPS in settings.py.

INSTALLED_APPS = [
    ...
    'request_viewer',
    ...
]

Add 'request_viewer.middleware.RequestViewerMiddleware' to your MIDDLEWARE list in settings.py.

MIDDLEWARE = [
    ...
    'request_viewer.middleware.RequestViewerMiddleware',
    ...
]  

To log exceptions, add

Add 'request_viewer.middleware.ExceptionMiddleware' to your MIDDLEWARE list in settings.py.

MIDDLEWARE = [
    ...
    'request_viewer.middleware.ExceptionMiddleware',
    ...
]  

Add 'request-viewer' to your main urls.py

urlpatterns = [
  ...
  path('logs/', include('request_viewer.urls'))
  ...
]

Run migrations, python manage.py migrate request_viewer

OPTIONAL

Add REQUEST_VIEWER dictionary to your settings.py.

LIVE_MONITORING: Default: True, False to pause monitoring.

WHITELISTED_PATH: Default: [], This is a list of paths to be excluded when monitoring

{
  "LIVE_MONITORING": True,
  "WHITELISTED_PATH": ['admin/']
}

Note: Media url, Static url and request-viewer url are automatically excluded.

Start your server and head to http://localhost:8000/logs/request-viewer to view requests

Head to http://localhost:8000/logs/request-viewer/exceptions to view exceptions

View your request logs.

Contribute

Well, no big drama, fork the repo and make pull requests, easy-peasy, right?

TODO

• JSON export
• Caching
• Create an African unicorn
• Buy a yacht

Credits

• Toni Akinmolayan - twitter GitHub
• Michael Trojan Okoh - twitter GitHub

Follow me (I am not boring, I promise)

• Twitter
• Github