django-activity-audit 1.3.0.dev9__tar.gz → 1.3.0.dev11__tar.gz

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-activity-audit
-Version: 1.3.0.dev9
+Version: 1.3.0.dev11
 Summary: A Django package for easy CRUD operation logging and container logs
 Project-URL: Homepage, https://github.com/shree256/django-activity-audit
 Project-URL: Repository, https://github.com/shree256/django-activity-audit

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/activity_audit/__init__.py

@@ -2,6 +2,10 @@ default_app_config = "activity_audit.apps.AuditLoggingConfig"
 
 from activity_audit.utils import (
     get_api_handler,
+    get_async_api_handler,
+    get_async_audit_handler,
+    get_async_json_handler,
+    get_async_login_handler,
     get_audit_handler,
     get_console_formatter,
     get_json_formatter,
@@ -18,4 +22,8 @@ __all__ = [
     "get_api_handler",
     "get_audit_handler",
     "get_login_handler",
+    "get_async_json_handler",
+    "get_async_api_handler",
+    "get_async_audit_handler",
+    "get_async_login_handler",
 ]

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/activity_audit/formatters.py

@@ -4,6 +4,8 @@ import json
 import logging
 import uuid
 
+from activity_audit.middleware import get_request_id
+
 
 def _json_default(obj):
     """
@@ -47,6 +49,7 @@ class JsonFormatter(logging.Formatter):
             "path": record.pathname,
             "module": record.module,
             "function": record.funcName,
+            "request_id": get_request_id() or "",
             "message": record.getMessage(),
             "exception": "",
             # "extra": {},
@@ -86,6 +89,7 @@ class APIFormatter(logging.Formatter):
             "service_name",
             "request_type",
             "protocol",
+            "request_id",
             "user_id",
             "user_info",
             "request_repr",
@@ -117,6 +121,7 @@ class AuditFormatter(logging.Formatter):
         audit_fields = [
             "model",
             "event_type",
+            "request_id",
             "instance_id",
             "instance_repr",
             "user_id",

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/activity_audit/middleware.py

@@ -3,6 +3,7 @@ import json
 import logging
 import re
 import time
+import uuid
 
 from asgiref.local import Local
 from asgiref.sync import iscoroutinefunction, markcoroutinefunction, sync_to_async
@@ -32,6 +33,14 @@ def set_current_request(request):
     _thread_locals.request = request
 
 
+def get_request_id():
+    return getattr(_thread_locals, "request_id", None)
+
+
+def set_request_id(request_id):
+    _thread_locals.request_id = request_id
+
+
 def get_current_user():
     request = get_current_request()
     if request:
@@ -68,6 +77,8 @@ def get_user_details():
 def clear_request():
     with contextlib.suppress(AttributeError):
         del _thread_locals.request
+    with contextlib.suppress(AttributeError):
+        del _thread_locals.request_id
 
 
 def should_log_url(url):
@@ -119,6 +130,7 @@ class AuditLoggingMiddleware(MiddlewareMixin):
             "service_name": SERVICE_NAME,
             "request_type": REQUEST_TYPES[0],
             "protocol": None,
+            "request_id": "",
             "user_id": "",
             "user_info": {},
             "request_repr": {},
@@ -134,6 +146,8 @@ class AuditLoggingMiddleware(MiddlewareMixin):
         if iscoroutinefunction(self):
             return self.__acall__(request)
         set_current_request(request)
+        request_id = str(uuid.uuid4())
+        set_request_id(request_id)
 
         if not should_log_url(request.path):
             return self.get_response(request)
@@ -184,6 +198,7 @@ class AuditLoggingMiddleware(MiddlewareMixin):
 
         self.log_data["execution_time"] = end_time - start_time
         self.log_data["protocol"] = "https" if request.is_secure() else "http"
+        self.log_data["request_id"] = request_id
         self.log_data["request_repr"] = request_data
         self.log_data["response_repr"] = response_data
 
@@ -195,6 +210,8 @@ class AuditLoggingMiddleware(MiddlewareMixin):
 
     async def __acall__(self, request):
         set_current_request(request)
+        request_id = str(uuid.uuid4())
+        set_request_id(request_id)
 
         if not should_log_url(request.path):
             return await self.get_response(request)
@@ -247,6 +264,7 @@ class AuditLoggingMiddleware(MiddlewareMixin):
 
         self.log_data["execution_time"] = end_time - start_time
         self.log_data["protocol"] = "https" if request.is_secure() else "http"
+        self.log_data["request_id"] = request_id
         self.log_data["request_repr"] = request_data
         self.log_data["response_repr"] = response_data
 

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/activity_audit/signals.py

@@ -15,7 +15,7 @@ from django.db.models.signals import (
 from django.dispatch import receiver
 from django.forms.models import model_to_dict
 
-from activity_audit.middleware import get_user_details
+from activity_audit.middleware import get_request_id, get_user_details
 from activity_audit.settings import UNREGISTERED_CLASSES
 
 logger = logging.getLogger("audit.model")
@@ -96,6 +96,7 @@ def push_log(
             "model": model,
             "instance_id": str(instance_id),
             "event_type": event_type,
+            "request_id": get_request_id() or "",
             "user_id": user_id,
             "user_info": user_info,
             "instance_repr": instance_repr,

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11/docs}/django-activity-audit.md

@@ -620,6 +620,87 @@ INSERT INTO rbp_stag_logs.audit FORMAT JSONEachRow
 
 ---
 
-## Future Scope
+## Part E: Async Handlers
 
-- Async implementation using **`QueueListener`** and **`QueueHandler`**.
+All four handler types have non-blocking async variants. Each async handler subclasses `QueueHandler` — the calling (request) thread only enqueues the log record, and a dedicated background thread owned by a `QueueListener` performs the actual file I/O.
+
+### How It Works
+
+```
+Request thread          Background thread
+──────────────          ─────────────────
+emit(record)
+  └─ queue.put()  ───►  QueueListener.dequeue()
+  (returns immediately)   └─ RotatingFileHandler.emit()
+                               └─ write to file + rotate if needed
+```
+
+### Async Handler Classes
+
+| Async Handler | Wraps | Formatter |
+|---|---|---|
+| `AsyncAPILogHandler` | `APILogHandler` | `APIFormatter` |
+| `AsyncAuditLogHandler` | `AuditLogHandler` | `AuditFormatter` |
+| `AsyncLoginLogHandler` | `LoginLogHandler` | `LoginFormatter` |
+| `AsyncJsonHandler` | `RotatingFileHandler` | `JsonFormatter` |
+
+Each handler starts its `QueueListener` thread on `__init__` and stops it cleanly on `close()` (called automatically by Django on shutdown).
+
+### Utility Functions
+
+Async counterparts match the signatures of their sync equivalents:
+
+```python
+from activity_audit import (
+    get_async_json_handler,
+    get_async_api_handler,
+    get_async_audit_handler,
+    get_async_login_handler,
+)
+```
+
+#### `get_async_json_handler`
+
+```python
+get_async_json_handler(
+    level="DEBUG",
+    filename="audit_logs/app.log",
+    max_bytes=1024 * 1024 * 10,  # 10MB
+    backup_count=5,
+)
+```
+
+> Note: unlike `get_json_handler`, there is no `formatter` parameter — `JsonFormatter` is embedded directly on the inner handler so it applies on the background thread.
+
+#### `get_async_api_handler`
+
+```python
+get_async_api_handler(filename="audit_logs/api.log")
+```
+
+#### `get_async_audit_handler`
+
+```python
+get_async_audit_handler(filename="audit_logs/audit.log")
+```
+
+#### `get_async_login_handler`
+
+```python
+get_async_login_handler(filename="audit_logs/login.log")
+```
+
+### Example Django LOGGING Configuration
+
+```python
+LOGGING = {
+    "version": 1,
+    "handlers": {
+        "app_file": get_async_json_handler(level="INFO", filename="audit_logs/app.log"),
+        "api_file": get_async_api_handler(filename="audit_logs/api.log"),
+        "audit_file": get_async_audit_handler(filename="audit_logs/audit.log"),
+        "login_file": get_async_login_handler(filename="audit_logs/login.log"),
+    },
+    ...
+}
+```

{django_activity_audit-1.3.0.dev9 → django_activity_audit-1.3.0.dev11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-activity-audit"
-version = "1.3.0.dev9"
+version = "1.3.0.dev11"
 description = "A Django package for easy CRUD operation logging and container logs"
 authors = [
     { name = "Shreeshan", email = "shreeshan256@gmail.com" }