Extend model.

Author: aiden_lu

drf_api_logger/admin.py

@@ -1,12 +1,15 @@
 from datetime import timedelta
 
 from django.conf import settings
-from django.contrib import admin
+from django.contrib import admin, messages
 from django.db.models import Count
 from django.http import HttpResponse
 
+from rest_framework.test import APIClient
+
 from drf_api_logger.utils import database_log_enabled
 
+
 if database_log_enabled():
     from drf_api_logger.models import APILogsModel
     from django.utils.translation import gettext_lazy as _
@@ -77,7 +80,7 @@ def queryset(self, request, queryset):
 
     class APILogsAdmin(admin.ModelAdmin, ExportCsvMixin):
 
-        actions = ["export_as_csv"]
+        actions = ["retry", "export_as_csv"]
 
         def __init__(self, model, admin_site):
             super().__init__(model, admin_site)
@@ -96,12 +99,13 @@ def added_on_time(self, obj):
         added_on_time.short_description = 'Added on'
 
         list_per_page = 20
-        list_display = ('id', 'api', 'method', 'status_code', 'execution_time', 'added_on_time',)
-        list_filter = ('added_on', 'status_code', 'method',)
+        list_display = ('id', 'api', 'method', 'result_code', 'request_user', 'execution_time', 'added_on_time',)
+        list_filter = ('added_on', 'result_code', 'method',)
         search_fields = ('body', 'response', 'headers', 'api',)
         readonly_fields = (
             'execution_time', 'client_ip_address', 'api',
-            'headers', 'body', 'method', 'response', 'status_code', 'added_on_time',
+            'headers', 'body', 'method', 'response',
+            'result_code', 'request_user', 'added_on_time',
         )
         exclude = ('added_on',)
 
@@ -116,12 +120,12 @@ def changelist_view(self, request, extra_context=None):
             except:
                 return response
             analytics_model = filtered_query_set.values('added_on__date').annotate(total=Count('id')).order_by('total')
-            status_code_count_mode = filtered_query_set.values('id').values('status_code').annotate(
-                total=Count('id')).order_by('status_code')
+            status_code_count_mode = filtered_query_set.values('id').values('result_code').annotate(
+                total=Count('id')).order_by('result_code')
             status_code_count_keys = list()
             status_code_count_values = list()
             for item in status_code_count_mode:
-                status_code_count_keys.append(item.get('status_code'))
+                status_code_count_keys.append(item.get('result_code'))
                 status_code_count_values.append(item.get('total'))
             extra_context = dict(
                 analytics=analytics_model,
@@ -152,5 +156,31 @@ def has_add_permission(self, request, obj=None):
         def has_change_permission(self, request, obj=None):
             return False
 
+        def retry(self, request, queryset):
+            """
+            Perform retry
+            """
+            if hasattr(settings, "DRF_API_LOGGER_RETRY_AUTH_TOKEN"):
+                self.message_user(
+                    request,
+                    "You must set 'DRF_API_LOGGER_RETRY_AUTH_TOKEN' in django settings before making a retry request.",
+                    level=messages.ERROR
+                )
+                return
+
+            if len(queryset) > 1:
+                self.message_user(request, "You cannot retry in batch!", level=messages.ERROR)
+                return
+
+            api_log = queryset[0]
+            client = APIClient()
+            client.force_authenticate(token=settings.DRF_API_LOGGER_RETRY_AUTH_TOKEN)
+            client.request(
+                api_log.method,
+                api_log.api,
+                data=self.body,
+                format='json',
+            )
+
 
     admin.site.register(APILogsModel, APILogsAdmin)

drf_api_logger/middleware/api_logger_middleware.py

@@ -1,13 +1,12 @@
 import json
 import time
-import bleach
 from django.conf import settings
 from django.urls import resolve
 from django.utils import timezone
 
 from drf_api_logger import API_LOGGER_SIGNAL
 from drf_api_logger.start_logger_when_server_starts import LOGGER_THREAD
-from drf_api_logger.utils import get_headers, get_client_ip, mask_sensitive_data
+from drf_api_logger.utils import get_headers, get_client_ip, mask_sensitive_data, get_result_code
 
 """
 File: api_logger_middleware.py
@@ -51,6 +50,10 @@ def __init__(self, get_response):
                     settings.DRF_API_LOGGER_METHODS) is list:
                 self.DRF_API_LOGGER_METHODS = settings.DRF_API_LOGGER_METHODS
 
+        self.DRF_API_LOGGER_RESULT_CODE_KEY = 'ret'
+        if hasattr(settings, 'DRF_API_LOGGER_RESULT_CODE_KEY'):
+            self.DRF_API_LOGGER_RESULT_CODE_KEY = settings.DRF_API_LOGGER_RESULT_CODE_KEY
+
     def __call__(self, request):
 
         # Run only if logger is enabled.
@@ -117,6 +120,8 @@ def __call__(self, request):
                     client_ip_address=get_client_ip(request),
                     response=mask_sensitive_data(response_body),
                     status_code=response.status_code,
+                    result_code=get_result_code(response_body, self.DRF_API_LOGGER_RESULT_CODE_KEY),
+                    request_user=request.user if not request.user.is_anonymous else None,
                     execution_time=time.time() - start_time,
                     added_on=timezone.now()
                 )

drf_api_logger/models.py

@@ -1,4 +1,6 @@
+from django.conf import settings
 from django.db import models
+from user_agents import parse
 
 from drf_api_logger.utils import database_log_enabled
 
@@ -28,12 +30,24 @@ class APILogsModel(BaseModel):
         client_ip_address = models.CharField(max_length=50)
         response = models.TextField()
         status_code = models.PositiveSmallIntegerField(help_text='Response status code', db_index=True)
+        result_code = models.PositiveSmallIntegerField(help_text='Result code', null=True, db_index=True)
+        request_user = models.ForeignKey(settings.AUTH_USER, null=True, on_delete=models.CASCADE, help_text="Request User")
+        retry_times = models.IntegerField(default=0)
         execution_time = models.DecimalField(decimal_places=5, max_digits=8,
                                              help_text='Server execution time (Not complete response time.)')
 
         def __str__(self):
             return self.api
 
+        @property
+        def browser(self):
+            ua_string = self.headers.get("USER_AGENT")
+            if ua_string is None:
+                return "Unknown"
+
+            user_agent = parse(ua_string)
+            return f"{user_agent.browser.family} {user_agent.browser.version_string}"
+
         class Meta:
             db_table = 'drf_api_logs'
             verbose_name = 'API Log'

drf_api_logger/utils.py

@@ -67,3 +67,10 @@ def mask_sensitive_data(data):
             data[key] = [mask_sensitive_data(item) for item in data[key]]
 
     return data
+
+
+def get_result_code(request_body, key):
+    try:
+        return request_body.get(key)
+    except AttributeError:
+        pass

requirements.txt

@@ -30,3 +30,6 @@ twine==3.4.1
 urllib3==1.26.4
 webencodings==0.5.1
 zipp==3.4.1
+pyyaml==6.0
+ua-parser==0.10.0
+user-agents==2.2.0