Create a custom logging filter to extract the client's IP address

Author: carlosribas

rnacentral/rnacentral/settings.py

@@ -203,10 +203,15 @@
     "disable_existing_loggers": False,
     "formatters": {
         "standard": {
-            "format": "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s",  # pylint: disable=W0401, C0301
+            "format": "[%(asctime)s] %(levelname)s [%(name)s:%(lineno)s] %(message)s (IP: %(client_ip)s)",
             "datefmt": "%d/%b/%Y %H:%M:%S",
         }
     },
+    "filters": {
+        "client_ip": {
+            "()": "rnacentral.utils.logging_filters.ClientIPFilter",
+        },
+    },
     "handlers": {
         "null": {
             "level": "DEBUG",
@@ -216,6 +221,7 @@
             "level": "INFO",
             "class": "logging.StreamHandler",  # writes to stderr
             "formatter": "standard",
+            "filters": ["client_ip"],
         },
     },
     "loggers": {

rnacentral/rnacentral/utils/logging_filters.py

@@ -0,0 +1,14 @@
+class ClientIPFilter:
+    def filter(self, record):
+        # Attempt to add the client IP to the log record
+        request = getattr(record, "request", None)
+        if request:
+            x_forwarded_for = request.META.get("HTTP_X_FORWARDED_FOR")
+            record.client_ip = (
+                x_forwarded_for.split(",")[0]
+                if x_forwarded_for
+                else request.META.get("REMOTE_ADDR")
+            )
+        else:
+            record.client_ip = "unknown"
+        return True