Merge pull request #13 from vishalanandl177/dev

Version 1.0.6

Author: vishalanandl177

README.md

@@ -1,5 +1,5 @@
 # DRF API Logger
-![version](https://img.shields.io/badge/version-1.0.5-blue.svg)
+![version](https://img.shields.io/badge/version-1.0.6-blue.svg)
 [![Downloads](https://pepy.tech/badge/drf-api-logger)](http://pepy.tech/project/drf-api-logger)
 [![Downloads](https://pepy.tech/badge/drf-api-logger/month)](https://pepy.tech/project/drf-api-logger)
 [![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://opensource.org/)
@@ -79,6 +79,8 @@ DRF_API_LOGGER_DATABASE = True  # Default to False
 
 ![Alt text](https://raw.githubusercontent.com/vishalanandl177/DRF-API-Logger/master/logs.png?raw=true, "Logger")
 
+![Alt text](https://raw.githubusercontent.com/vishalanandl177/DRF-API-Logger/master/graph.png?raw=true, "Graph")
+
 ![Alt text](https://raw.githubusercontent.com/vishalanandl177/DRF-API-Logger/master/lists.png?raw=true, "Lists")
 
 ![Alt text](https://raw.githubusercontent.com/vishalanandl177/DRF-API-Logger/master/details.png?raw=true, "Details")
@@ -134,11 +136,11 @@ DRF_LOGGER_QUEUE_MAX_SIZE = 50  # Default to 50 if not specified.
 
 DRF API Logger also waits for a period of time. If queue is not full and there are some logs to be inserted, it inserts after interval ends.
 
-Specify interval (In Seconds).
+Specify an interval (In Seconds).
 ```python
 DRF_LOGGER_INTERVAL = 10  # In Seconds, Default to 10 seconds if not specified.
 ```
-Note: The API call time (added_on) is timezone aware datetime object. It is actual time of API call irrespective of interval value or queue size.
+Note: The API call time (added_on) is a timezone aware datetime object. It is actual time of API call irrespective of interval value or queue size.
 ### Skip namespace
 You can skip the entire app to be logged into the database by specifying namespace of the app as list.
 ```python
@@ -196,7 +198,7 @@ Select records for status_code 200.
 result_for_200_status_code = APILogsModel.objects.filter(status_code=200)
 ```
 
-Model:
+DRF API Logger Model:
 ```
 class APILogsModel(Model):
    id = models.BigAutoField(primary_key=True)

dist/drf_api_logger-1.0.6.tar.gz

@@ -1,10 +1,8 @@
 from django.contrib import admin
 from django.db.models import Count
 
-
 from drf_api_logger.utils import database_log_enabled
 
-
 if database_log_enabled():
     from drf_api_logger.models import APILogsModel
 
@@ -34,7 +32,18 @@ def changelist_view(self, request, extra_context=None):
             response = super(APILogsAdmin, self).changelist_view(request, extra_context)
             filtered_query_set = response.context_data["cl"].queryset
             analytics_model = filtered_query_set.values('added_on__date').annotate(total=Count('id')).order_by('total')
-            extra_context = dict(analytics=analytics_model)
+            status_code_count_mode = filtered_query_set.values('id').values('status_code').annotate(
+                total=Count('id')).order_by('status_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_values.append(item.get('total'))
+            extra_context = dict(
+                analytics=analytics_model,
+                status_code_count_keys=status_code_count_keys,
+                status_code_count_values=status_code_count_values
+            )
             response.context_data.update(extra_context)
             return response
 
@@ -47,4 +56,5 @@ def has_change_permission(self, request, obj=None):
         def has_delete_permission(self, request, obj=None):
             return False
 
+
     admin.site.register(APILogsModel, APILogsAdmin)

drf_api_logger/admin.py

@@ -89,39 +89,38 @@ def __call__(self, request):
                         response_body = json.loads(response.content.decode())
                     else:
                         response_body = json.loads(response.content)
+                if self.DRF_API_LOGGER_PATH_TYPE == 'ABSOLUTE':
+                    api = request.build_absolute_uri()
+                elif self.DRF_API_LOGGER_PATH_TYPE == 'FULL_PATH':
+                    api = request.get_full_path()
+                elif self.DRF_API_LOGGER_PATH_TYPE == 'RAW_URI':
+                    api = request.get_raw_uri()
+                else:
+                    api = request.build_absolute_uri()
+
+                data = dict(
+                    api=api,
+                    headers=headers,
+                    body=request_data,
+                    method=method,
+                    client_ip_address=get_client_ip(request),
+                    response=response_body,
+                    status_code=response.status_code,
+                    execution_time=time.time() - start_time,
+                    added_on=timezone.now()
+                )
+                if self.DRF_API_LOGGER_DATABASE:
+                    if LOGGER_THREAD:
+                        d = data.copy()
+                        d['headers'] = json.dumps(d['headers'], indent=4)
+                        if request_data:
+                            d['body'] = json.dumps(d['body'], indent=4)
+                        d['response'] = json.dumps(d['response'], indent=4)
+                        LOGGER_THREAD.put_log_data(data=d)
+                if self.DRF_API_LOGGER_SIGNAL:
+                    API_LOGGER_SIGNAL.listen(**data)
             else:
-                response_body = '** Not JSON **'
-
-            if self.DRF_API_LOGGER_PATH_TYPE == 'ABSOLUTE':
-                api = request.build_absolute_uri()
-            elif self.DRF_API_LOGGER_PATH_TYPE == 'FULL_PATH':
-                api = request.get_full_path()
-            elif self.DRF_API_LOGGER_PATH_TYPE == 'RAW_URI':
-                api = request.get_raw_uri()
-            else:
-                api = request.build_absolute_uri()
-
-            data = dict(
-                api=api,
-                headers=headers,
-                body=request_data,
-                method=method,
-                client_ip_address=get_client_ip(request),
-                response=response_body,
-                status_code=response.status_code,
-                execution_time=time.time() - start_time,
-                added_on=timezone.now()
-            )
-            if self.DRF_API_LOGGER_DATABASE:
-                if LOGGER_THREAD:
-                    d = data.copy()
-                    d['headers'] = json.dumps(d['headers'], indent=4)
-                    if request_data:
-                        d['body'] = json.dumps(d['body'], indent=4)
-                    d['response'] = json.dumps(d['response'], indent=4)
-                    LOGGER_THREAD.put_log_data(data=d)
-            if self.DRF_API_LOGGER_SIGNAL:
-                API_LOGGER_SIGNAL.listen(**data)
+                return response
         else:
             response = self.get_response(request)
         return response

drf_api_logger/middleware/api_logger_middleware.py

@@ -7,10 +7,10 @@
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.8.0/Chart.min.css" />
 <script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.8.0/Chart.bundle.min.js"></script>
 <script>
+
 document.addEventListener('DOMContentLoaded', () => {
-  const ctx = document.getElementById('myChart').getContext('2d');
+  const ctx = document.getElementById('countChart').getContext('2d');
 
-  // Sample data
   const chartData = [
     {% for item in analytics %}
     {"date": "{{ item.added_on__date }}", "y": {{ item.total }}},
@@ -60,14 +60,49 @@
       },
     },
   });
+
+  var color = Chart.helpers.color;
+
+  var barChartData = {
+      labels: {{ status_code_count_keys }},
+      datasets: [{
+          label: 'Number of API calls by status code',
+          backgroundColor: 'rgb(33,150,243)',
+          borderColor: 'rgb(33,150,243)',
+          borderWidth: 1,
+          data: {{ status_code_count_values }}
+      }]
+  };
+
+  window.onload = function() {
+      var ctx = document.getElementById('statusCodeChart').getContext('2d');
+      window.myBar = new Chart(ctx, {
+          type: 'bar',
+          data: barChartData,
+          options: {
+              responsive: true,
+              legend: {
+                  position: 'top',
+              },
+              title: {
+                  display: true,
+                  text: 'API calls by status code'
+              }
+          }
+      });
+
+  };
 });
 </script>
 {% endblock %}
 
 {% block content %}
 <!-- Render our chart -->
 <div style="width: 80%;">
-  <canvas style="margin-bottom: 30px; width: 60%; height: 50%;" id="myChart"></canvas>
+  <canvas style="margin-bottom: 30px; width: 60%; height: 50%;" id="countChart"></canvas>
+</div>
+<div style="width: 80%; margin-top: 24px;">
+  <canvas style="margin-bottom: 30px; width: 60%; height: 50%;" id="statusCodeChart"></canvas>
 </div>
 <!-- Render the rest of the ChangeList view -->
 {{ block.super }}

drf_api_logger/templates/charts_change_list.html

@@ -21,7 +21,7 @@ def get_long_desc():
 
 setuptools.setup(
     name="drf_api_logger",
-    version="1.0.5",
+    version="1.0.6",
     author="Vishal Anand",
     author_email="vishalanandl177@gmail.com",
     description="An API Logger for your Django Rest Framework project.",