Add NetworkContextFilter

README.rst

@@ -31,6 +31,13 @@ Installation
 The pacakage on PyPI is named ``humiologging``, same as the package name.
 Install with for instance ``pip install humiologging``.
 
+Filters
+-------
+
+``humiologging.filters.NetworkContextFilter``
+    Optional filter that adds public and local ip to the log-record. Use with
+    any handler. Mostly useful for debugging.
+
 Formatters
 ----------
 

src/humiologging/filters.py

@@ -0,0 +1,12 @@
+import logging
+from .utils import find_my_local_ip, find_my_public_ip
+
+
+class NetworkContextFilter(logging.Filter):
+    public_ip = find_my_public_ip()
+    local_ip = find_my_local_ip()
+
+    def filter(self, record):
+        record.public_ip = self.public_ip
+        record.local_ip = self.local_ip
+        return True

src/humiologging/utils.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timezone
+import requests
 import socket
 
 
@@ -42,3 +43,18 @@ def make_safe_for_json(recorddict):
         if not isinstance(value, PRIMITIVE_TYPES):
             recorddict[key] = repr(value)
     return recorddict
+
+
+def find_my_public_ip():
+    response = requests.get("https://httpbin.org/ip")
+    if response.status_code == 200:
+        server_ip = response.json()['origin']
+        return server_ip
+    return None
+
+
+def find_my_local_ip():
+    try:
+        return socket.gethostbyname(socket.gethostname())
+    except socket.error:
+        return None