15 |
16 |
17 | Recently, [@ichtrojan](https://github.com/ichtrojan) and [@toniastro](https://github.com/toniastro) released [horus](https://github.com/ichtrojan/horus), a request logger and viewer for Go. Then I felt the need for something like that for the Django community.
18 |
19 | ### Installation
20 |
21 | Install using pip
22 |
23 | ```bash
24 | pip install django-request-viewer
25 | ```
26 |
27 | ### Usage
28 |
29 |
30 | Add `'request-viewer'` to your `INSTALLED_APPS` in settings.py.
31 |
32 | INSTALLED_APPS = [
33 | ...
34 | 'request_viewer',
35 | ...
36 | ]
37 |
38 |
39 | Add `'request_viewer.middleware.RequestViewerMiddleware'` to your MIDDLEWARE list in settings.py.
40 |
41 | MIDDLEWARE = [
42 | ...
43 | 'request_viewer.middleware.RequestViewerMiddleware',
44 | ...
45 | ]
46 |
47 | ##### To log exceptions, add
48 |
49 | Add `'request_viewer.middleware.ExceptionMiddleware'` to your MIDDLEWARE list in settings.py.
50 |
51 | MIDDLEWARE = [
52 | ...
53 | 'request_viewer.middleware.ExceptionMiddleware',
54 | ...
55 | ]
56 |
57 | Add `'request-viewer'` to your main urls.py
58 |
59 | urlpatterns = [
60 | ...
61 | path('logs/', include('request_viewer.urls'))
62 | ...
63 | ]
64 |
65 | Run migrations, `python manage.py migrate request_viewer`
66 |
67 | **OPTIONAL**
68 |
69 | Add `REQUEST_VIEWER` dictionary to your settings.py.
70 |
71 |
72 | **LIVE_MONITORING**: Default: `True`, False to pause monitoring.
73 |
74 | **WHITELISTED_PATH**: Default: `[]`, This is a list of paths to be excluded when monitoring
75 |
76 | {
77 | "LIVE_MONITORING": True,
78 | "WHITELISTED_PATH": ['admin/']
79 | }
80 |
81 | **Note**: Media url, Static url and request-viewer url are automatically excluded.
82 | 
92 |
93 | ### Contribute
94 |
95 | Well, no big drama, fork the repo and make pull requests, easy-peasy, right?
96 |
97 | ### TODO
98 | * JSON export
99 | * Caching
100 | * Create an African unicorn
101 | * Buy a yacht
102 |
103 | ### Credits
104 |
105 | * Toni Akinmolayan - [twitter](https://twitter.com/toniastro_) [GitHub](https://github.com/toniastro)
106 | * Michael Trojan Okoh - [twitter](https://twitter.com/ichtrojan) [GitHub](https://github.com/ichtrojan)
107 |
108 |
109 |
110 | ### Follow me (I am not boring, I promise)
111 | * [Twitter](https://twitter.com/sirrobot01)
112 | * [Github](https://github.com/sirrobot01)
113 |
114 |
115 |
116 |
117 |
--------------------------------------------------------------------------------
/request_viewer/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sirrobot01/django-request-viewer/41e24f97bb4d92212724c8dbf9b275e68c81c39f/request_viewer/__init__.py
--------------------------------------------------------------------------------
/request_viewer/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 |
3 | # Register your models here.
4 | from . import models
5 |
6 | admin.site.register(models.Logger)
7 |
--------------------------------------------------------------------------------
/request_viewer/apps.py:
--------------------------------------------------------------------------------
1 | from django.apps import AppConfig
2 |
3 |
4 | class RequestViewerConfig(AppConfig):
5 | name = 'request_viewer'
6 |
--------------------------------------------------------------------------------
/request_viewer/conf.py:
--------------------------------------------------------------------------------
1 | from django.conf import settings
2 |
3 | # Request viewer configs
4 | REQUEST_VIEWER = getattr(settings, 'REQUEST_VIEWER', {})
5 | LIVE_MONITORING = REQUEST_VIEWER.get('LIVE_MONITORING', True)
6 | WHITELISTED_PATHS = REQUEST_VIEWER.get('WHITELISTED_PATH', [])
7 | # LOG_EXCEPTIONS = REQUEST_VIEWER.get('LOG_EXCEPTIONS') @TODO Exception logger
8 | DATETIME_FORMAT = "%d %b %Y %H:%M:%S.%f"
9 |
10 | # Static and media files
11 | STATIC_URL = getattr(settings, 'STATIC_URL', '/static/')
12 | MEDIA_URL = getattr(settings, 'MEDIA_URL', '/media/')
13 |
--------------------------------------------------------------------------------
/request_viewer/middleware.py:
--------------------------------------------------------------------------------
1 | from django.template.response import TemplateResponse
2 | from django.urls import reverse
3 | from django.conf import settings
4 | import os, traceback
5 |
6 | from .models import RequestModel, ResponseModel, Logger, TemplateResponseModel, ExceptionModel
7 | from .conf import WHITELISTED_PATHS, DATETIME_FORMAT, LIVE_MONITORING
8 | from .utils import is_whitelisted, get_time_length
9 |
10 | default_whitelist = [
11 | os.path.normpath(path) for path in [reverse('request-viewer'),
12 | reverse('modal-content'), settings.MEDIA_URL, settings.STATIC_URL]]
13 |
14 | WHITELISTED_PATHS.extend(default_whitelist)
15 |
16 |
17 | class RequestViewerMiddleware:
18 |
19 | def __init__(self, get_response):
20 | self.get_response = get_response
21 | self.request_obj = {}
22 | self.response_obj = {}
23 |
24 | def __call__(self, request):
25 | path = request.path
26 | if not is_whitelisted(os.path.normpath(path), WHITELISTED_PATHS) and LIVE_MONITORING:
27 | self.request_obj = RequestModel(request).__dict__
28 | obj, _ = Logger.objects.get_or_create(path=path)
29 | response = self.get_response(request)
30 | if isinstance(response, TemplateResponse):
31 | self.response_obj = TemplateResponseModel(response).__dict__
32 | else:
33 | self.response_obj = ResponseModel(response).__dict__
34 | old_data = obj.data
35 | time_length = get_time_length(self.request_obj.get('request_timestamp'), self.response_obj.get('response_timestamp'), DATETIME_FORMAT)
36 | self.request_obj['time_length'] = time_length
37 | parsed_data = dict(self.request_obj, **self.response_obj)
38 | if parsed_data not in old_data:
39 | old_data.append(parsed_data)
40 |
41 | obj.data = old_data
42 | obj.save()
43 | return response
44 |
45 | return self.get_response(request)
46 |
47 | class ExceptionMiddleware:
48 | def __init__(self, get_response):
49 | self.get_response = get_response
50 |
51 | def __call__(self, request):
52 | return self.get_response(request)
53 |
54 | def process_exception(self, request, exception):
55 | path = request.path
56 | if not is_whitelisted(os.path.normpath(path), WHITELISTED_PATHS) and LIVE_MONITORING:
57 | self.run_exception(exception)
58 |
59 | @staticmethod
60 | def run_exception(exception):
61 | tb = exception.__traceback__
62 |
63 | traces = traceback.extract_tb(tb)
64 |
65 | exec_type = type(exception).__name__
66 | stacks = []
67 | for frame in traces:
68 | stack = {
69 | 'filename': frame.filename,
70 | 'lineno': frame.lineno,
71 | 'name': frame.name,
72 | 'line': frame.line,
73 | 'locals': frame.locals
74 | }
75 | stacks.append(stack)
76 | if hasattr(exception, "message"):
77 | message = exception.message
78 | else:
79 | message = None
80 |
81 | last_stack = stacks[-1] if stacks else {}
82 | obj = ExceptionModel(
83 | func_name=last_stack.get("name"),
84 | line_no=last_stack.get("lineno"),
85 | line=last_stack.get("line"),
86 | exc_type=exec_type,
87 | message=message,
88 | stacks=stacks
89 | )
90 | obj.save()
91 |
--------------------------------------------------------------------------------
/request_viewer/migrations/0001_initial.py:
--------------------------------------------------------------------------------
1 | # Generated by Django 3.1.7 on 2021-03-25 19:16
2 |
3 | from django.db import migrations, models
4 |
5 |
6 | class Migration(migrations.Migration):
7 |
8 | initial = True
9 |
10 | dependencies = [
11 | ]
12 |
13 | operations = [
14 | migrations.CreateModel(
15 | name='Logger',
16 | fields=[
17 | ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
18 | ('path', models.CharField(blank=True, max_length=255, null=True)),
19 | ('data', models.JSONField(default=list)),
20 | ],
21 | ),
22 | ]
23 |
--------------------------------------------------------------------------------
/request_viewer/migrations/0002_exceptionmodel_alter_logger_id.py:
--------------------------------------------------------------------------------
1 | # Generated by Django 4.0.1 on 2022-01-17 10:33
2 |
3 | from django.db import migrations, models
4 |
5 |
6 | class Migration(migrations.Migration):
7 |
8 | dependencies = [
9 | ('request_viewer', '0001_initial'),
10 | ]
11 |
12 | operations = [
13 | migrations.CreateModel(
14 | name='ExceptionModel',
15 | fields=[
16 | ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
17 | ('exc_type', models.CharField(max_length=255)),
18 | ('message', models.TextField(blank=True, null=True)),
19 | ('func_name', models.CharField(max_length=1024)),
20 | ('line_no', models.IntegerField()),
21 | ('line', models.TextField(blank=True, null=True)),
22 | ('stacks', models.JSONField(default=list)),
23 | ('logged_at', models.DateTimeField(auto_now_add=True)),
24 | ],
25 | ),
26 | migrations.AlterField(
27 | model_name='logger',
28 | name='id',
29 | field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),
30 | ),
31 | ]
32 |
--------------------------------------------------------------------------------
/request_viewer/migrations/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sirrobot01/django-request-viewer/41e24f97bb4d92212724c8dbf9b275e68c81c39f/request_viewer/migrations/__init__.py
--------------------------------------------------------------------------------
/request_viewer/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 | import json
3 | from django.conf import settings
4 | from django.http import HttpRequest, StreamingHttpResponse
5 | from datetime import datetime
6 |
7 | from .conf import DATETIME_FORMAT
8 | try:
9 | from django.db.models import JSONField
10 | except ModuleNotFoundError:
11 | try:
12 | from jsonfield import JSONField
13 | except:
14 | from django.contrib.postgres.fields import JSONField
15 |
16 |
17 | # Create your models here.
18 |
19 |
20 | class Logger(models.Model):
21 | path = models.CharField(max_length=255, blank=True, null=True)
22 | data = JSONField(default=list)
23 |
24 | @classmethod
25 | def get_data(cls, filter_by=None, value=None):
26 | data = []
27 | logs = cls.objects.all()
28 | for log in logs:
29 | log_data = log.data
30 | data.extend(log_data)
31 | return data
32 |
33 |
34 | class BaseClass:
35 |
36 | def to_json(self):
37 | return json.dumps(self.__dict__)
38 |
39 |
40 | class RequestModel(BaseClass):
41 | LOG_EXCEPTIONS = getattr(settings, "LOG_EXCEPTIONS", False)
42 |
43 | def __init__(self, request: HttpRequest):
44 | self.path = request.path
45 | self.method = request.method
46 | self.request_timestamp = datetime.now().strftime(DATETIME_FORMAT)
47 | self.params = dict(request.GET) if self.method == "GET" else dict(request.POST)
48 | self.files = dict(request.FILES)
49 | self.headers = dict(request.headers)
50 | self.authenticated_request = request.user.is_authenticated
51 |
52 | def get_object(self):
53 | return self.__class__(**self.__dict__)
54 |
55 | @property
56 | def __dict__(self):
57 | return {
58 | "path": self.path,
59 | "method": self.method,
60 | "params": self.params,
61 | "files": self.files,
62 | "headers": self.headers,
63 | "request_timestamp": self.request_timestamp
64 | }
65 |
66 |
67 | class BaseResponse(BaseClass):
68 |
69 | def __init__(self, response):
70 | self.status_code = response.status_code
71 | self.status_message = response.reason_phrase
72 | self.content_type = response.charset
73 | self.response_datetime = datetime.now().strftime(DATETIME_FORMAT)
74 | super(BaseResponse, self).__init__()
75 |
76 | @property
77 | def __dict__(self):
78 | return {
79 | "status_code": self.status_code,
80 | "status_message": self.status_message,
81 | "content_type": self.content_type,
82 | "response_timestamp": self.response_datetime
83 | }
84 |
85 |
86 | class ResponseModel(BaseResponse):
87 |
88 | def __init__(self, response):
89 | if isinstance(response, StreamingHttpResponse):
90 | self.message = "StreamingHttpResponse"
91 | elif isinstance(response.content, bytes):
92 | self.message = response.content.decode()
93 | else:
94 | self.message = response.content
95 | super(ResponseModel, self).__init__(response)
96 |
97 | @property
98 | def __dict__(self):
99 | return dict(super(ResponseModel, self).__dict__, **{"message": self.message})
100 |
101 | class TemplateResponseModel(BaseResponse):
102 |
103 | def __init__(self, response):
104 | self.template_name = response.template_name
105 | context_data = response.context_data
106 | self.view = str(context_data.get('view'))
107 | super(TemplateResponseModel, self).__init__(response)
108 |
109 | @property
110 | def __dict__(self):
111 | data = {
112 | "template_name": self.template_name,
113 | "view": self.view
114 | }
115 | return dict(super(TemplateResponseModel, self).__dict__, **data)
116 |
117 |
118 | class ExceptionModel(models.Model):
119 | exc_type = models.CharField(max_length=255)
120 | message = models.TextField(blank=True, null=True)
121 | func_name = models.CharField(max_length=1024)
122 | line_no = models.IntegerField()
123 | line = models.TextField(blank=True, null=True)
124 | stacks = JSONField(default=list)
125 | logged_at = models.DateTimeField(auto_now_add=True)
126 |
127 |
--------------------------------------------------------------------------------
/request_viewer/templates/request_viewer/exception.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | | Exception: {{ obj.exc_type }} | 6 |
| Line No: {{ obj.line_no }} | 9 |
| Message: {{ obj.message }} | 12 |
| Logged time: {{ obj.logged_at }} | 15 |
{{ obj.message }}
32 | {{ key }}: {{ value }}
40 | {% endif %}
41 | {% endfor %}
42 | | 11 | Type 12 | | 13 |15 | Function 16 | | 17 |19 | Line Number 20 | | 21 |23 | Message 24 | | 25 |27 | Timestamp 28 | | 29 |30 | 31 | | 32 |
|---|---|---|---|---|---|
| 38 | {{ exception.exc_type }} 39 | | 40 |41 | {{ exception.func_name }} 42 | | 43 |44 | {{ exception.line_no }} 45 | | 46 |47 | {{ exception.message }} 48 | | 49 |50 | {{ exception.logged_at }} 51 | | 52 |53 | Details 55 | | 56 |
| Host: {{ obj.headers.Host }} | 6 |
| Method: {{ obj.method }} | 9 |
| Status: {{ obj.status_code }} | 12 |
| Path: {{ obj.path }} | 15 |
| Response content type: {{ obj.content_type }} | 18 |
| Templates: {{ obj.template_name }} | 22 |
{{ key }}:
51 | {{ value }}
52 | {% endif %}
53 | {% endfor %}
54 | }
55 | {{ key }}: {{ value }}
62 | {% endif %}
63 | {% endfor %}
64 | }
65 | {{ key }}: {{ value }}
73 | {% endfor %}
74 | }
75 | {% else %}
76 | {{ obj.message|safe }}
77 | {% endif %}
78 | {% else %}
79 | { }
80 | {% endif %}
81 | {{ key }}: {{ value }}
88 | {% endif %}
89 | {% endfor %}
90 | }
91 | | 11 | Method 12 | | 13 |15 | Path 16 | | 17 |19 | Status code 20 | | 21 |23 | Status message 24 | | 25 |27 | Duration 28 | | 29 |31 | Timestamp 32 | | 33 |34 | 35 | | 36 |
|---|---|---|---|---|---|---|
| 42 | {{ path.method }} 43 | | 44 |45 | {{ path.path }} 46 | | 47 |48 | 50 | {{ path.status_code }} 51 | 52 | | 53 |54 | {{ path.status_message }} 55 | | 56 |57 | {% if path.time_length %} {{ path.time_length }}s {% endif %} 58 | 59 | | 60 |61 | {{ path.request_timestamp }} 62 | | 63 |64 | Details 66 | | 67 |