added logging request city and request country using geoip2

Pipfile

@@ -19,6 +19,7 @@ tox = "*"
 mock = "*"
 django = ">=3.0.7"
 six = ">=1.13.0"
+geoip2 = ""
 
 [requires]
 python_version = ">=3.7"

requirements.txt

@@ -2,6 +2,7 @@
 Django>=1.11
 djangorestframework>=3.5
 six>=1.14.0
+geoip2>=4.1.0
 
 # Test requirements
 pytest-django

rest_framework_tracking/admin.py

@@ -5,7 +5,7 @@
 
 class APIRequestLogAdmin(admin.ModelAdmin):
     date_hierarchy = 'requested_at'
-    list_display = ('id', 'requested_at', 'response_ms', 'status_code',
+    list_display = ('requested_at', 'response_ms', 'status_code',
                     'user', 'method',
                     'path', 'remote_addr', 'host',
                     'query_params')
@@ -16,7 +16,7 @@ class APIRequestLogAdmin(admin.ModelAdmin):
     if getattr(settings, 'DRF_TRACKING_ADMIN_LOG_READONLY', False):
         readonly_fields = ('user', 'username_persistent', 'requested_at',
                            'response_ms', 'path', 'view', 'view_method',
-                           'remote_addr', 'host', 'method', 'query_params',
+                           'remote_addr', 'request_city', 'request_country', 'host', 'method', 'query_params',
                            'data', 'response', 'errors', 'status_code')
 
 

rest_framework_tracking/base_mixins.py

@@ -5,10 +5,18 @@
 
 from django.db import connection
 from django.utils.timezone import now
+from django.contrib.gis.geoip2 import GeoIP2
+from django.conf import settings
 
 
 logger = logging.getLogger(__name__)
 
+# create an instance of GeoIP2 if GEOIP_PATH was set in settings.py
+if hasattr(settings, 'GEOIP_PATH'):
+    geo_location = GeoIP2()
+else:
+    geo_location = None
+
 
 class BaseLoggingMixin(object):
     """Mixin to log requests"""
@@ -70,10 +78,12 @@ def finalize_response(self, request, response, *args, **kwargs):
                 rendered_content = response.rendered_content
             else:
                 rendered_content = response.getvalue()
+
+            ip_address = self._get_ip_address(request)
 
             self.log.update(
                 {
-                    "remote_addr": self._get_ip_address(request),
+                    "remote_addr": ip_address,
                     "view": self._get_view_name(request),
                     "view_method": self._get_view_method(request),
                     "path": request.path,
@@ -91,6 +101,15 @@ def finalize_response(self, request, response, *args, **kwargs):
             )
             if self._clean_data(request.query_params.dict()) == {}:
                 self.log.update({"query_params": self.log["data"]})
+
+            # update request city and country
+            if geo_location:
+                try:
+                    geo_location_data = geo_location.city(ip_address)
+                    self.log.update({"request_city": geo_location_data["city"], "request_country": geo_location_data["country_name"]})
+                except Exception:
+                    pass
+
             try:
                 self.handle_log()
             except Exception:

rest_framework_tracking/base_models.py

@@ -37,6 +37,8 @@ class BaseAPIRequestLog(models.Model):
         db_index=True,
     )
     remote_addr = models.GenericIPAddressField()
+    request_city = models.CharField(max_length=255, null=True, blank=True)
+    request_country = models.CharField(max_length=255, null=True, blank=True)
     host = models.URLField()
     method = models.CharField(max_length=10)
     query_params = models.TextField(null=True, blank=True)

rest_framework_tracking/migrations/0011_auto_20201123_1321.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.1.3 on 2020-11-23 13:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('rest_framework_tracking', '0010_auto_20200609_1404'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='apirequestlog',
+            name='request_city',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='apirequestlog',
+            name='request_country',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+    ]