django-analytics-middleware 0.1.0__py3-none-any.whl

django-audit-analytics-middleware/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

django-audit-analytics-middleware/apps.py

@@ -0,0 +1,105 @@
+import os
+import sys
+import logging
+from django.conf import settings
+from django.apps import AppConfig
+from django.core.exceptions import ImproperlyConfigured
+
+
+class AnalyticsMiddlewareConfig(AppConfig):
+    """Django app configuration for the analytics middleware"""
+
+    name = "django_analytics_middleware"
+    verbose_name = "Django Analytics Middleware"
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self):
+        """
+        Called once when Django starts
+        """
+        if self._is_running_management_command():
+            return
+
+        # Validation Configuration
+        self._validate_configuration()
+        self._setup_package_logging()
+
+        logger = logging.getLogger(__name__)
+        logger.info("Analytics middleware initiated successfully")
+
+    def _is_running_management_command(self):
+        """Check if Django is running a command"""
+        return len(sys.argv) > 1 and sys.argv[1] in [
+            "migrate",
+            "makemigrations",
+            "collectstatic",
+            "flush",
+            "loaddata",
+            "dumpdata",
+        ]
+
+    def _validate_configuration(self):
+        """Validate user settings at startup"""
+        log_path = getattr(settings, "ANALYTICS_LOG_PATH", None)
+
+        if not log_path:
+            print(
+                "Analytics middleware: You must set ANALYTICS_LOG_PATH in your settings.py"
+            )
+            print(
+                "Example: ANALYTICS_LOG_PATH = os.path.join(BASEDIR, 'logs', 'analytics.log')"
+            )
+            print("Or in .env ANALYTICS_LOG_PATH=<LOG PATH>")
+            raise ImproperlyConfigured(
+                "Analytics middleware: You must set ANALYTICS_LOG_PATH in your settings.py\n"
+                "Example: ANALYTICS_LOG_PATH = os.path.join(BASEDIR, 'logs', 'analytics.log')\n"
+                "Or in .env ANALYTICS_LOG_PATH=<LOG PATH>"
+            )
+
+        # Test directory actually exists and create
+        log_dir = os.path.dirname(log_path)
+        if log_dir and not os.path.exists(log_dir):
+            try:
+                os.makedirs(log_dir, exist_ok=True)
+                print(f"Created log directory: {log_dir}")
+
+            except PermissionError:
+                raise RuntimeError(
+                    f"Analytics middleware: Cannot create directory '{log_dir}'."
+                    f"Either fix permissions or change ANALYTICS_LOG_PATH within settings.py."
+                )
+
+        # Tries to write to log to test permissions
+        try:
+            with open(log_path, "a") as test_file:
+                test_file.write("")
+        except PermissionError:
+            raise ImproperlyConfigured(
+                "Can't write to log file. Please ensure you have the correct permissions on your log folder."
+            )
+
+        # Retrieves noise paths list from settings.py
+        noise_paths = getattr(settings, "ANALYTICS_NOISE_PATHS", None)
+        if noise_paths is None:
+            print("No noise path field discovered within settings.py.")
+            print("Using default noise paths: /health, /admin, /favicon.ico")
+            noise_paths = ["/health", "/admin", "/favicon.ico"]  # Set default
+
+    def _setup_package_logging(self):
+        """Configure logging"""
+
+        log_level_name = getattr(settings, "ANALYTICS_LOG_LEVEL", "WARNING")
+        log_level = getattr(logging, log_level_name.upper(), logging.WARNING)
+
+        # Configure package logger
+        logger = logging.getLogger(__name__)
+        logger.setLevel(log_level)
+
+        # Dont add handlers if already configured
+        if not logger.handlers:
+            handler = logging.StreamHandler()
+            formatter = logging.Formatter(
+                "[%(asctime)s] %(levelname)s: %(message)s", datefmt="%d-%m-%Y %H:%M:%S"
+            )
+            handler.setFormatter(formatter)
+            logger.addHandler(handler)

django-audit-analytics-middleware/middleware.py

@@ -0,0 +1,58 @@
+from django.utils import timezone
+from django.conf import settings
+import json
+
+
+class AnalyticsMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+        self.log_path = getattr(settings, "ANALYTICS_LOG_PATH", None)
+        self.noise_paths = getattr(
+            settings, "ANALYTICS_NOISE_PATHS", ["/health", "/admin", "/favicon.ico"]
+        )
+        self.disabled = not self.log_path
+
+    def __call__(self, request):
+        if self.disabled:
+            return self.get_response(request)
+
+        if any(request.path.startswith(path) for path in self.noise_paths):
+            return self.get_response(request)
+
+        start = timezone.now()
+        response = self.get_response(request)
+        duration = timezone.now() - start
+
+        x_forwarded_for = request.META.get("HTTP_X_FORWARDED_FOR")
+        ip = (
+            x_forwarded_for.split(",")[0].strip()
+            if x_forwarded_for
+            else request.META.get("REMOTE_ADDR")
+        )
+
+        log_entry = {
+            "path": request.path,
+            "method": request.method,
+            "status": response.status_code,
+            "user_uuid": str(request.user.uuid)
+            if request.user.is_authenticated
+            else "unauthorized user",
+            "duration_ms": int(round(duration.total_seconds() * 1000)),
+            "ip": ip,
+            "user_agent": request.META.get("HTTP_USER_AGENT", ""),
+            "referrer": request.META.get("HTTP_REFERER", ""),
+            "timestamp": timezone.now().isoformat(),
+            "month": timezone.now().strftime("%b"),
+            "week": timezone.now().strftime("%V"),
+            "day": timezone.now().strftime("%a"),
+            "hour": timezone.now().strftime("%H"),
+        }
+
+        try:
+            with open(self.log_path, "a") as f:
+                f.write(json.dumps(log_entry) + "\n")
+
+        except Exception as e:
+            print(f"[Analytics Middleware Error]: {str(e)}")
+
+        return response

django_analytics_middleware-0.1.0.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: django-analytics-middleware
+Version: 0.1.0
+Summary: Django middleware for request analytics logging
+Author-email: Aaron Browne <github@futurumlabs.net>
+License: MIT
+Project-URL: Homepage, https://github.com/Knowledgex187/django-audit-analytics-middleware.git
+Project-URL: Source, https://github.com/Knowledgex187/django-audit-analytics-middleware.git
+Project-URL: Issues, https://github.com/Knowledgex187/django-audit-analytics-middleware.git/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: Django
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=2.2
+Dynamic: license-file
+
+# django-audit-analytics-middleware
+
+**One middleware. Audit logs for compliance. Analytics for product.**
+
+## Status: 🏗️ Building in public
+
+This package is under active development. I'm posting every step on LinkedIn.
+
+## What it will do (already working locally)
+
+- [x] Log every request (path, method, status, user, IP, user agent)
+- [x] Filter noise paths (/admin, /health, /static)
+- [x] Duration tracking in milliseconds
+- [x] IP extraction behind proxies (X-Forwarded-For)
+- [ ] Configurable log file path
+- [ ] Django admin view for logs
+- [ ] Export to CSV/JSON command
+- [ ] Tests (coming this week)
+- [ ] PyPI release
+
+## Features
+
+- 📊 Logs all HTTP requests with timing data
+- 👤 Captures authenticated user UUIDs
+- 🌐 Extracts real IP addresses (handles proxies)
+- 🚫 Skips configurable noise paths (health checks, admin, etc.)
+- 📝 Writes JSON logs for easy parsing
+- ⚡ Minimal performance impact
+- 🔒 Never breaks your application if logging fails
+
+## Want to help?
+
+- Open an issue with your wishlist
+- Star the repo to follow progress
+- DM me on LinkedIn
+
+## Installation
+
+```bash
+pip install django-analytics-middleware
+
+
+# Add to INSTALLED_APPS
+INSTALLED_APPS = [
+    ...
+    'django_analytics_middleware',
+]
+
+# Add to MIDDLEWARE
+MIDDLEWARE = [
+    ...
+    'django_analytics_middleware.middleware.AnalyticsMiddleware',
+]
+
+# Configure log path
+ANALYTICS_LOG_PATH = os.path.join(BASE_DIR, 'logs', 'analytics.log')
+
+# For .env in settings.py
+ANALYTICS_LOG_PATH = ANALYTICS_LOG_PATH=<env_handler>(<LOG PATH>)
+
+Configuration
+Required Settings
+Setting	Description	Example
+ANALYTICS_LOG_PATH	Where to write log files	os.path.join(BASE_DIR, 'logs', 'analytics.log')
+Optional Settings
+Setting	Default	Description
+ANALYTICS_NOISE_PATHS	['/health', '/admin', '/favicon.ico']	Paths to skip logging
+ANALYTICS_LOG_LEVEL	'WARNING'	Logging level for the package
+
+
+# Example settings.py
+
+# Required
+ANALYTICS_LOG_PATH = os.path.join(BASE_DIR, 'logs', 'analytics.log')
+
+# Optional - Custom noise paths
+ANALYTICS_NOISE_PATHS = [
+    '/health',
+    '/metrics', 
+    '/admin',
+    '/favicon.ico',
+    '/robots.txt'
+]
+
+# Optional - Set log level (DEBUG, INFO, WARNING, ERROR)
+ANALYTICS_LOG_LEVEL = 'INFO'
+
+
+# Log Format
+{
+  "path": "/api/users/",
+  "method": "GET",
+  "status": 200,
+  "user_uuid": "550e8400-e29b-41d4-a716-446655440000",
+  "duration_ms": 45,
+  "ip": "192.168.1.100",
+  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
+  "referrer": "https://example.com/",
+  "timestamp": "2024-01-15T10:30:45.123456+00:00",
+  "month": "Jan",
+  "week": "03",
+  "day": "Mon",
+  "hour": "10"
+}
+
+# Log Field Descriptions
+Field	         Type	    Description
+path	         string	    Request URL path
+method	         string	    HTTP method (GET, POST, PUT, DELETE, etc.)
+status	         integer	HTTP response status code
+user_uuid	     string	    Authenticated user's UUID or "unauthorized user"
+duration_ms	     integer	Request processing time in milliseconds
+ip	string	     Client     IP address (handles proxy forwarding)
+user_agent	     string	    Browser/device user agent string
+referrer	     string	    Referring URL (where user came from)
+timestamp	     string	    ISO 8601 timestamp with timezone
+month	         string	    Three-letter month abbreviation (Jan, Feb, Mar)
+week	         string	    ISO week number (01-53)
+day	             string	    Three-letter day abbreviation (Mon, Tue, Wed)
+hour	         string	    Hour in 24-hour format (00-23)
+
+## License
+
+MIT – because audit logs shouldn't be paywalled.

django_analytics_middleware-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+django-audit-analytics-middleware/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+django-audit-analytics-middleware/apps.py,sha256=SltiFWtPir85UqAUrDMJGgPZL7fc8yMzePtL-v8iPwg,3889
+django-audit-analytics-middleware/middleware.py,sha256=USE8indBk8ss_ia3S_a72R2ciA2_W_-2BEtqS-v8e6o,1996
+django_analytics_middleware-0.1.0.dist-info/licenses/LICENSE,sha256=F5eAheQ2ng9GuuSo5_mJJVKvAbyN41fyb2Vj1Fsa45I,1072
+django_analytics_middleware-0.1.0.dist-info/METADATA,sha256=227twJVnodlpFHkKI3iDAXN0jhhusfIA1axHUWrqVU4,4396
+django_analytics_middleware-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+django_analytics_middleware-0.1.0.dist-info/top_level.txt,sha256=kEMpjYS0hzHWI0-ToyrDdS-2q9GiMGVa7z7rAjavGk0,34
+django_analytics_middleware-0.1.0.dist-info/RECORD,,

django_analytics_middleware-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_analytics_middleware-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Futurumlabs Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_analytics_middleware-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+django-audit-analytics-middleware