django-activity-audit 1.3.0.dev8__tar.gz → 1.3.0.dev10__tar.gz

{django_activity_audit-1.3.0.dev8 → django_activity_audit-1.3.0.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-activity-audit
-Version: 1.3.0.dev8
+Version: 1.3.0.dev10
 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.dev8 → django_activity_audit-1.3.0.dev10}/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.dev10/activity_audit/handlers.py

@@ -0,0 +1,166 @@
+import logging
+import queue
+
+from logging.handlers import QueueHandler, QueueListener, RotatingFileHandler
+
+from .formatters import APIFormatter, AuditFormatter, JsonFormatter, LoginFormatter
+
+
+class BaseAuditHandler(RotatingFileHandler):
+    """Base handler for all audit logs with common emit logic."""
+
+    def emit(self, record):
+        """
+        Emit a record with additional values for audit-specific fields.
+        """
+        try:
+            # Handle extra if present
+            if hasattr(record, "extra"):
+                for key, value in record.extra.items():
+                    setattr(record, key, value)
+
+            super().emit(record)
+
+        except Exception as e:
+            self.handleError(record)
+            # Log the error to the root logger
+            logging.getLogger().error(f"Error in AuditLogHandler: {str(e)}")
+
+
+class APILogHandler(BaseAuditHandler):
+    """Handler for API audit logs with default APIFormatter."""
+
+    def __init__(
+        self,
+        filename,
+        mode="a",
+        maxBytes=0,
+        backupCount=0,
+        encoding=None,
+        delay=False,
+    ):
+        super().__init__(filename, mode, maxBytes, backupCount, encoding, delay)
+        self.setFormatter(APIFormatter())
+
+
+class AuditLogHandler(BaseAuditHandler):
+    """Handler for model audit logs with default AuditFormatter."""
+
+    def __init__(
+        self,
+        filename,
+        mode="a",
+        maxBytes=0,
+        backupCount=0,
+        encoding=None,
+        delay=False,
+    ):
+        super().__init__(filename, mode, maxBytes, backupCount, encoding, delay)
+        self.setFormatter(AuditFormatter())
+
+
+class LoginLogHandler(BaseAuditHandler):
+    """Handler for login audit logs with default LoginFormatter."""
+
+    def __init__(
+        self,
+        filename,
+        mode="a",
+        maxBytes=0,
+        backupCount=0,
+        encoding=None,
+        delay=False,
+    ):
+        super().__init__(filename, mode, maxBytes, backupCount, encoding, delay)
+        self.setFormatter(LoginFormatter())
+
+
+# ASYNC ------------------------------------------------------
+class AsyncBaseAuditHandler(QueueHandler):
+    """
+    Base async handler. Enqueues records on the calling thread; a background
+    QueueListener thread does the actual file write via the wrapped sync handler.
+
+    Subclasses pass the concrete sync handler class and formatter via
+    _sync_handler_class and _formatter_class.
+    """
+
+    _sync_handler_class = None
+    _formatter_class = None
+
+    def __init__(
+        self,
+        filename,
+        mode="a",
+        maxBytes=0,
+        backupCount=0,
+        encoding=None,
+        delay=False,
+    ):
+        log_queue = queue.Queue(-1)
+        super().__init__(log_queue)
+
+        sync_handler = self._sync_handler_class(
+            filename, mode, maxBytes, backupCount, encoding, delay
+        )
+        self._listener = QueueListener(
+            log_queue, sync_handler, respect_handler_level=True
+        )
+        self._listener.start()
+
+    def close(self):
+        self._listener.stop()
+        super().close()
+
+
+class AsyncAPILogHandler(AsyncBaseAuditHandler):
+    """Non-blocking handler for API audit logs."""
+
+    _sync_handler_class = APILogHandler
+    _formatter_class = APIFormatter
+
+
+class AsyncAuditLogHandler(AsyncBaseAuditHandler):
+    """Non-blocking handler for model audit logs."""
+
+    _sync_handler_class = AuditLogHandler
+    _formatter_class = AuditFormatter
+
+
+class AsyncLoginLogHandler(AsyncBaseAuditHandler):
+    """Non-blocking handler for login audit logs."""
+
+    _sync_handler_class = LoginLogHandler
+    _formatter_class = LoginFormatter
+
+
+class AsyncJsonHandler(QueueHandler):
+    """
+    Non-blocking handler for general JSON logs. Wraps a RotatingFileHandler
+    with JsonFormatter on the background thread.
+    """
+
+    def __init__(
+        self,
+        filename,
+        mode="a",
+        maxBytes=0,
+        backupCount=0,
+        encoding=None,
+        delay=False,
+    ):
+        log_queue = queue.Queue(-1)
+        super().__init__(log_queue)
+
+        sync_handler = RotatingFileHandler(
+            filename, mode, maxBytes, backupCount, encoding, delay
+        )
+        sync_handler.setFormatter(JsonFormatter())
+        self._listener = QueueListener(
+            log_queue, sync_handler, respect_handler_level=True
+        )
+        self._listener.start()
+
+    def close(self):
+        self._listener.stop()
+        super().close()

{django_activity_audit-1.3.0.dev8 → django_activity_audit-1.3.0.dev10}/activity_audit/utils.py

@@ -63,6 +63,58 @@ def get_login_handler(
     }
 
 
+# ASYNC ------------------------------------------------------
+def get_async_json_handler(
+    level: str = "DEBUG",
+    filename: str = "audit_logs/app.log",
+    max_bytes: int = 1024 * 1024 * 10,
+    backup_count: int = 5,
+) -> dict:
+    return {
+        "level": level,
+        "class": "activity_audit.handlers.AsyncJsonHandler",
+        "filename": filename,
+        "maxBytes": max_bytes,
+        "backupCount": backup_count,
+    }
+
+
+def get_async_api_handler(
+    filename: str = "audit_logs/api.log",
+) -> dict:
+    return {
+        "class": "activity_audit.handlers.AsyncAPILogHandler",
+        "filename": filename,
+        "maxBytes": 1024 * 1024 * 10,  # 10MB
+        "backupCount": 5,
+    }
+
+
+def get_async_audit_handler(
+    filename: str = "audit_logs/audit.log",
+) -> dict:
+    return {
+        "class": "activity_audit.handlers.AsyncAuditLogHandler",
+        "filename": filename,
+        "maxBytes": 1024 * 1024 * 10,  # 10MB
+        "backupCount": 5,
+    }
+
+
+def get_async_login_handler(
+    filename: str = "audit_logs/login.log",
+) -> dict:
+    return {
+        "class": "activity_audit.handlers.AsyncLoginLogHandler",
+        "filename": filename,
+        "maxBytes": 1024 * 1024 * 5,  # 5MB
+        "backupCount": 5,
+    }
+
+
+# ----------------------------------------------------------------
+
+
 def push_usage_log(
     message: str,
     event: str,