django-cfg 1.5.1__py3-none-any.whl → 1.5.2__py3-none-any.whl

django_cfg/apps/rq/apps.py

@@ -0,0 +1,80 @@
+"""
+AppConfig for Django-RQ integration with monitoring and API capabilities.
+
+This app provides REST API endpoints for Django-RQ task queue monitoring,
+management, and statistics. It wraps django-rq's functionality with modern
+DRF ViewSets and unified django-cfg patterns.
+
+Features:
+- REST API for monitoring queues, workers, and jobs
+- Prometheus metrics integration
+- Enhanced monitoring interfaces
+- Job management (view, requeue, delete)
+- Integration with django-cfg ecosystem (Centrifugo, auth)
+"""
+
+from django.apps import AppConfig
+
+
+class RQAppConfig(AppConfig):
+    """
+    AppConfig for Django-RQ monitoring and management application.
+
+    Provides:
+    - REST API endpoints for monitoring
+    - Prometheus metrics export
+    - Job and queue management
+    - Worker statistics
+    - Integration with django-cfg authentication
+
+    Usage:
+        Add to INSTALLED_APPS:
+        INSTALLED_APPS = [
+            ...
+            'django_rq',  # Required: django-rq core
+            'django_cfg.apps.rq',  # Django-CFG RQ monitoring
+        ]
+
+        Configure in django-cfg config:
+        class MyConfig(BaseConfig):
+            django_rq: DjangoRQConfig = DjangoRQConfig(
+                enabled=True,
+                queues={
+                    'default': {
+                        'host': 'localhost',
+                        'port': 6379,
+                        'db': 0,
+                    }
+                },
+                prometheus_enabled=True,
+            )
+    """
+
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_cfg.apps.rq'
+    verbose_name = 'Django-CFG RQ Monitoring'
+    label = 'django_cfg_rq'
+
+    def ready(self):
+        """
+        Initialize the app when Django starts.
+
+        Registers:
+        - Admin interfaces (if not already registered)
+        - Signal handlers for monitoring
+        - Scheduled jobs from config
+        """
+        # Import admin to register custom admin classes
+        try:
+            from . import admin  # noqa: F401
+        except ImportError:
+            pass
+
+        # Register scheduled jobs from config (runs once on startup)
+        try:
+            from .services import register_schedules_from_config
+            register_schedules_from_config()
+        except Exception as e:
+            from django_cfg.modules.django_logging import get_logger
+            logger = get_logger("rq.apps")
+            logger.warning(f"Failed to register schedules: {e}")

django_cfg/apps/rq/management/__init__.py

@@ -0,0 +1 @@
+"""Management commands for Django-RQ integration."""

django_cfg/apps/rq/management/commands/__init__.py

@@ -0,0 +1 @@
+"""Django-RQ management commands for django-cfg."""

django_cfg/apps/rq/management/commands/rqscheduler.py

@@ -0,0 +1,31 @@
+"""
+Django-CFG wrapper for django-rq rqscheduler command.
+
+Runs the RQ scheduler daemon for scheduled/periodic jobs.
+
+Example:
+    python manage.py rqscheduler
+    python manage.py rqscheduler --queue default
+"""
+
+from django_rq.management.commands.rqscheduler import Command as DjangoRQSchedulerCommand
+
+
+class Command(DjangoRQSchedulerCommand):
+    """
+    Runs the RQ scheduler daemon.
+
+    The scheduler handles:
+    - Scheduled jobs (enqueue at specific time)
+    - Periodic jobs (cron-like scheduling)
+    - Delayed job execution
+
+    Inherits all functionality from django-rq's rqscheduler command.
+
+    Common options:
+        --queue QUEUE        Queue to schedule jobs on (default: 'default')
+        --interval SECONDS   Polling interval (default: 1)
+        --pid FILE          Write PID to file
+    """
+
+    help = 'Runs RQ scheduler daemon for django-cfg (wrapper for django-rq rqscheduler)'

django_cfg/apps/rq/management/commands/rqstats.py

@@ -0,0 +1,33 @@
+"""
+Django-CFG wrapper for django-rq rqstats command.
+
+Displays real-time statistics about RQ queues and workers.
+
+Example:
+    python manage.py rqstats
+    python manage.py rqstats --interval 5
+"""
+
+from django_rq.management.commands.rqstats import Command as DjangoRQStatsCommand
+
+
+class Command(DjangoRQStatsCommand):
+    """
+    Displays real-time RQ statistics in terminal.
+
+    Shows:
+    - Queue sizes (queued, started, finished, failed)
+    - Worker count and status
+    - Job processing rates
+    - Updates in real-time
+
+    Inherits all functionality from django-rq's rqstats command.
+
+    Common options:
+        --interval SECONDS   Update interval (default: 1)
+        --raw               Show raw numbers (no colors)
+        --only-queues       Show only queue statistics
+        --only-workers      Show only worker statistics
+    """
+
+    help = 'Shows real-time RQ statistics for django-cfg (wrapper for django-rq rqstats)'

django_cfg/apps/rq/management/commands/rqworker.py

@@ -0,0 +1,31 @@
+"""
+Django-CFG wrapper for django-rq rqworker command.
+
+This is a simple proxy that inherits all functionality from django-rq's rqworker.
+Allows running: python manage.py rqworker [queues]
+
+Example:
+    python manage.py rqworker default
+    python manage.py rqworker high default low
+    python manage.py rqworker default --with-scheduler
+"""
+
+from django_rq.management.commands.rqworker import Command as DjangoRQWorkerCommand
+
+
+class Command(DjangoRQWorkerCommand):
+    """
+    Runs RQ workers on specified queues.
+
+    Inherits all functionality from django-rq's rqworker command.
+    See django-rq documentation for available options.
+
+    Common options:
+        --burst              Run in burst mode (exit when queue is empty)
+        --with-scheduler     Run worker with embedded scheduler
+        --name NAME          Custom worker name
+        --worker-ttl SEC     Worker timeout (default: 420)
+        --sentry-dsn DSN     Report exceptions to Sentry
+    """
+
+    help = 'Runs RQ workers for django-cfg (wrapper for django-rq rqworker)'

django_cfg/apps/rq/management/commands/rqworker_pool.py

@@ -0,0 +1,27 @@
+"""
+Django-CFG wrapper for django-rq rqworker-pool command.
+
+Runs multiple RQ workers in a pool for better performance.
+
+Example:
+    python manage.py rqworker_pool default --num-workers 4
+    python manage.py rqworker_pool high default --num-workers 8
+"""
+
+from django_rq.management.commands.rqworker_pool import Command as DjangoRQWorkerPoolCommand
+
+
+class Command(DjangoRQWorkerPoolCommand):
+    """
+    Runs a pool of RQ workers for improved throughput.
+
+    Inherits all functionality from django-rq's rqworker-pool command.
+    Creates multiple worker processes to handle jobs in parallel.
+
+    Common options:
+        --num-workers N      Number of worker processes (default: CPU count)
+        --burst              Run in burst mode
+        --name NAME          Worker name prefix
+    """
+
+    help = 'Runs a pool of RQ workers for django-cfg (wrapper for django-rq rqworker-pool)'

django_cfg/apps/rq/serializers/__init__.py

@@ -0,0 +1,40 @@
+"""
+DRF serializers for Django-RQ monitoring API.
+"""
+
+from .health import HealthCheckSerializer, RQConfigSerializer
+from .queue import QueueStatsSerializer, QueueDetailSerializer
+from .worker import WorkerSerializer, WorkerStatsSerializer
+from .job import JobListSerializer, JobDetailSerializer, JobActionResponseSerializer
+from .schedule import (
+    ScheduleCreateSerializer,
+    ScheduledJobSerializer,
+    ScheduleActionResponseSerializer,
+)
+from .testing import (
+    TestScenarioSerializer,
+    RunDemoRequestSerializer,
+    StressTestRequestSerializer,
+    TestingActionResponseSerializer,
+    CleanupRequestSerializer,
+)
+
+__all__ = [
+    'HealthCheckSerializer',
+    'RQConfigSerializer',
+    'QueueStatsSerializer',
+    'QueueDetailSerializer',
+    'WorkerSerializer',
+    'WorkerStatsSerializer',
+    'JobListSerializer',
+    'JobDetailSerializer',
+    'JobActionResponseSerializer',
+    'ScheduleCreateSerializer',
+    'ScheduledJobSerializer',
+    'ScheduleActionResponseSerializer',
+    'TestScenarioSerializer',
+    'RunDemoRequestSerializer',
+    'StressTestRequestSerializer',
+    'TestingActionResponseSerializer',
+    'CleanupRequestSerializer',
+]

django_cfg/apps/rq/serializers/health.py

@@ -0,0 +1,60 @@
+"""
+Health check and configuration serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class HealthCheckSerializer(serializers.Serializer):
+    """
+    Health check response serializer.
+
+    Provides overall RQ cluster health status.
+    """
+
+    status = serializers.CharField(help_text="Health status (healthy/degraded/unhealthy)")
+    worker_count = serializers.IntegerField(help_text="Total number of active workers")
+    queue_count = serializers.IntegerField(help_text="Number of configured queues")
+    total_jobs = serializers.IntegerField(help_text="Total jobs across all queues")
+    timestamp = serializers.DateTimeField(help_text="Health check timestamp")
+    enabled = serializers.BooleanField(help_text="RQ enabled status")
+    redis_connected = serializers.BooleanField(help_text="Redis connection status")
+    wrapper_url = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        default="",
+        help_text="Wrapper URL (optional)"
+    )
+    has_api_key = serializers.BooleanField(
+        required=False,
+        default=False,
+        help_text="API key configured status"
+    )
+
+
+class RQConfigSerializer(serializers.Serializer):
+    """
+    RQ configuration serializer.
+
+    Returns current RQ configuration from django-cfg.
+    """
+
+    enabled = serializers.BooleanField(help_text="RQ enabled status")
+    queues = serializers.DictField(help_text="Configured queues")
+    async_mode = serializers.BooleanField(
+        default=True, help_text="Async mode enabled"
+    )
+    show_admin_link = serializers.BooleanField(
+        default=True, help_text="Show admin link"
+    )
+    prometheus_enabled = serializers.BooleanField(
+        default=True, help_text="Prometheus metrics enabled"
+    )
+    api_token_configured = serializers.BooleanField(
+        default=False, help_text="API token is configured"
+    )
+    schedules = serializers.ListField(
+        required=False,
+        default=list,
+        help_text="Scheduled tasks from django-cfg config"
+    )

django_cfg/apps/rq/serializers/job.py

@@ -0,0 +1,100 @@
+"""
+Job information serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class JobListSerializer(serializers.Serializer):
+    """
+    Job list item serializer.
+
+    Provides basic job information for list views.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func_name = serializers.CharField(help_text="Function name")
+    created_at = serializers.DateTimeField(help_text="Job creation time")
+    status = serializers.CharField(
+        help_text="Job status (queued/started/finished/failed)"
+    )
+    queue = serializers.CharField(help_text="Queue name")
+    timeout = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Job timeout in seconds"
+    )
+
+
+class JobDetailSerializer(serializers.Serializer):
+    """
+    Detailed job information serializer.
+
+    Provides comprehensive job details including result and metadata.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func_name = serializers.CharField(help_text="Function name")
+    args = serializers.ListField(default=list, help_text="Function arguments")
+    kwargs = serializers.DictField(default=dict, help_text="Function keyword arguments")
+
+    # Status and timing
+    created_at = serializers.DateTimeField(help_text="Job creation time")
+    enqueued_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job enqueue time"
+    )
+    started_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job start time"
+    )
+    ended_at = serializers.DateTimeField(
+        allow_null=True, required=False, help_text="Job end time"
+    )
+    status = serializers.CharField(
+        help_text="Job status (queued/started/finished/failed)"
+    )
+
+    # Queue and worker
+    queue = serializers.CharField(help_text="Queue name")
+    worker_name = serializers.CharField(
+        allow_null=True, required=False, help_text="Worker name if started"
+    )
+
+    # Configuration
+    timeout = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Result TTL in seconds"
+    )
+    failure_ttl = serializers.IntegerField(
+        allow_null=True, required=False, help_text="Failure TTL in seconds"
+    )
+
+    # Result and error
+    result = serializers.JSONField(
+        allow_null=True, required=False, help_text="Job result if finished"
+    )
+    exc_info = serializers.CharField(
+        allow_null=True, required=False, help_text="Exception info if failed"
+    )
+
+    # Metadata
+    meta = serializers.DictField(default=dict, help_text="Job metadata")
+    dependency_ids = serializers.ListField(
+        child=serializers.CharField(),
+        default=list,
+        help_text="List of dependency job IDs",
+    )
+
+
+class JobActionResponseSerializer(serializers.Serializer):
+    """
+    Job action response serializer.
+
+    Used for job management actions (requeue, delete, etc.).
+    """
+
+    success = serializers.BooleanField(help_text="Action success status")
+    message = serializers.CharField(help_text="Action result message")
+    job_id = serializers.CharField(help_text="Job ID")
+    action = serializers.CharField(
+        help_text="Action performed (requeue/delete/cancel)"
+    )

django_cfg/apps/rq/serializers/queue.py

@@ -0,0 +1,80 @@
+"""
+Queue statistics serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class QueueStatsSerializer(serializers.Serializer):
+    """
+    Queue statistics serializer.
+
+    Provides basic queue statistics.
+    """
+
+    name = serializers.CharField(help_text="Queue name")
+    count = serializers.IntegerField(help_text="Total jobs in queue")
+    queued_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs waiting to be processed"
+    )
+    started_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs currently being processed"
+    )
+    finished_jobs = serializers.IntegerField(default=0, help_text="Completed jobs")
+    failed_jobs = serializers.IntegerField(default=0, help_text="Failed jobs")
+    deferred_jobs = serializers.IntegerField(default=0, help_text="Deferred jobs")
+    scheduled_jobs = serializers.IntegerField(default=0, help_text="Scheduled jobs")
+    workers = serializers.IntegerField(
+        default=0, help_text="Number of workers for this queue"
+    )
+
+
+class QueueDetailSerializer(serializers.Serializer):
+    """
+    Detailed queue information serializer.
+
+    Provides comprehensive queue statistics and metadata.
+    """
+
+    name = serializers.CharField(help_text="Queue name")
+    count = serializers.IntegerField(help_text="Total jobs in queue")
+
+    # Job counts by status
+    queued_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs waiting to be processed"
+    )
+    started_jobs = serializers.IntegerField(
+        default=0, help_text="Jobs currently being processed"
+    )
+    finished_jobs = serializers.IntegerField(default=0, help_text="Completed jobs")
+    failed_jobs = serializers.IntegerField(default=0, help_text="Failed jobs")
+    deferred_jobs = serializers.IntegerField(default=0, help_text="Deferred jobs")
+    scheduled_jobs = serializers.IntegerField(default=0, help_text="Scheduled jobs")
+
+    # Worker information
+    workers = serializers.IntegerField(
+        default=0, help_text="Number of workers for this queue"
+    )
+
+    # Metadata
+    oldest_job_timestamp = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Timestamp of oldest job in queue",
+    )
+    connection_kwargs = serializers.DictField(
+        default=dict, help_text="Redis connection parameters"
+    )
+    is_async = serializers.BooleanField(default=True, help_text="Queue is in async mode")
+
+
+class QueueJobListSerializer(serializers.Serializer):
+    """
+    List of jobs in queue (simple view).
+    """
+
+    queue_name = serializers.CharField(help_text="Queue name")
+    total_jobs = serializers.IntegerField(help_text="Total number of jobs")
+    jobs = serializers.ListField(
+        child=serializers.CharField(), default=list, help_text="List of job IDs"
+    )

django_cfg/apps/rq/serializers/schedule.py

@@ -0,0 +1,178 @@
+"""
+Schedule management serializers for Django-RQ.
+"""
+
+from rest_framework import serializers
+
+
+class ScheduleCreateSerializer(serializers.Serializer):
+    """
+    Serializer for creating a scheduled job.
+
+    Supports three scheduling methods:
+    1. scheduled_time: Schedule job at specific time
+    2. interval: Schedule job to repeat at intervals
+    3. cron: Schedule job with cron expression
+    """
+
+    # Job configuration
+    func = serializers.CharField(
+        help_text="Function path (e.g., 'myapp.tasks.my_task')"
+    )
+    args = serializers.ListField(
+        default=list,
+        required=False,
+        help_text="Function arguments"
+    )
+    kwargs = serializers.DictField(
+        default=dict,
+        required=False,
+        help_text="Function keyword arguments"
+    )
+
+    # Queue configuration
+    queue_name = serializers.CharField(
+        default="default",
+        help_text="Queue name to schedule job in"
+    )
+
+    # Scheduling options (choose one)
+    scheduled_time = serializers.DateTimeField(
+        required=False,
+        allow_null=True,
+        help_text="Schedule job at specific time (ISO 8601)"
+    )
+    interval = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        min_value=1,
+        help_text="Schedule job to repeat every N seconds"
+    )
+    cron = serializers.CharField(
+        required=False,
+        allow_null=True,
+        help_text="Cron expression (e.g., '0 0 * * *' for daily at midnight)"
+    )
+
+    # Job options
+    timeout = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Result TTL in seconds"
+    )
+    repeat = serializers.IntegerField(
+        required=False,
+        allow_null=True,
+        help_text="Number of times to repeat (None = infinite)"
+    )
+    description = serializers.CharField(
+        required=False,
+        allow_null=True,
+        max_length=255,
+        help_text="Job description"
+    )
+
+    def validate(self, attrs):
+        """Validate that exactly one scheduling method is provided."""
+        scheduling_methods = [
+            attrs.get('scheduled_time'),
+            attrs.get('interval'),
+            attrs.get('cron'),
+        ]
+        provided_methods = [m for m in scheduling_methods if m is not None]
+
+        if len(provided_methods) == 0:
+            raise serializers.ValidationError(
+                "Must provide one of: scheduled_time, interval, or cron"
+            )
+
+        if len(provided_methods) > 1:
+            raise serializers.ValidationError(
+                "Can only provide one scheduling method: scheduled_time, interval, or cron"
+            )
+
+        return attrs
+
+
+class ScheduledJobSerializer(serializers.Serializer):
+    """
+    Serializer for scheduled job information.
+    """
+
+    id = serializers.CharField(help_text="Job ID")
+    func = serializers.CharField(help_text="Function path")
+    args = serializers.ListField(default=list, help_text="Function arguments")
+    kwargs = serializers.DictField(default=dict, help_text="Function keyword arguments")
+
+    # Schedule info
+    queue_name = serializers.CharField(help_text="Queue name")
+    scheduled_time = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Next scheduled time"
+    )
+    interval = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Repeat interval in seconds"
+    )
+    cron = serializers.CharField(
+        allow_null=True,
+        required=False,
+        help_text="Cron expression"
+    )
+
+    # Job options
+    timeout = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Job timeout in seconds"
+    )
+    result_ttl = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Result TTL in seconds"
+    )
+    repeat = serializers.IntegerField(
+        allow_null=True,
+        required=False,
+        help_text="Times to repeat (None = infinite)"
+    )
+    description = serializers.CharField(
+        allow_null=True,
+        required=False,
+        help_text="Job description"
+    )
+
+    # Metadata
+    created_at = serializers.DateTimeField(
+        allow_null=True,
+        required=False,
+        help_text="Job creation time"
+    )
+    meta = serializers.DictField(
+        default=dict,
+        help_text="Job metadata"
+    )
+
+
+class ScheduleActionResponseSerializer(serializers.Serializer):
+    """
+    Response serializer for schedule actions (create/delete).
+    """
+
+    success = serializers.BooleanField(help_text="Action success status")
+    message = serializers.CharField(help_text="Action result message")
+    job_id = serializers.CharField(
+        required=False,
+        allow_null=True,
+        help_text="Job ID (for create action)"
+    )
+    action = serializers.CharField(
+        help_text="Action performed (create/delete/cancel)"
+    )