arq-optimus-dashboard 0.1.0

Real-time monitoring dashboard and CLI for ARQ Optimus async task queues

ARQ Optimus Dashboard

Real-time monitoring dashboard and CLI for ARQ Optimus async task queues.

Features

• Real-time Dashboard — Auto-refreshing web UI with queue stats, job listing, status filtering
• Job Cancellation — Cancel queued/running jobs via dashboard or CLI using ARQ's native Job.abort()
• Job Management CLI (arq-optimus) — Stats, list, info, cancel, delete from the terminal
• Key Prefix Support — Works with ARQ Optimus key-prefix isolation for multi-project Redis
• FastAPI Backend — High-performance async API with Redis connection pooling
• Redis Cloud Support — Works with SSL/TLS connections

Installation

pip install arq-optimus-dashboard

This automatically installs arq-optimus as a dependency.

Dashboard

Start the Dashboard

# Basic usage
arq-optimus-dashboard --redis-url redis://localhost:6379

# With Redis Cloud (SSL)
arq-optimus-dashboard --redis-url rediss://:[e-mail]:6380

# With key prefix (must match your worker's key_prefix)
arq-optimus-dashboard --redis-url redis://localhost:6379 --key-prefix myproject

# Custom host and port
arq-optimus-dashboard --redis-url redis://localhost:6379 --host 127.0.0.1 --port 9000

# With basic auth
arq-optimus-dashboard --redis-url redis://localhost:6379 --username admin --password secret

Open your browser to http://localhost:8910 to see the dashboard.

Dashboard Features

• Queue Statistics — Live counts of queued, running, completed, failed, cancelled jobs
• Status Filtering — Filter jobs by status (queued / running / completed / failed / cancelled)
• Job Details — Click any job to see arguments, result, timing, errors
• Cancel Jobs — Cancel queued or running jobs with one click
• Delete Jobs — Clean up completed/failed/cancelled job records
• Auto-Refresh — Updates every 5 seconds

CLI (arq-optimus)

Manage jobs from the terminal without a dashboard:

# Queue statistics
arq-optimus stats --redis-url redis://localhost:6379

# List jobs (optionally filter by status)
arq-optimus list --redis-url redis://localhost:6379
arq-optimus list --redis-url redis://localhost:6379 --status running

# Job details
arq-optimus info <job_id> --redis-url redis://localhost:6379

# Cancel a job
arq-optimus cancel <job_id> --redis-url redis://localhost:6379

# Delete a completed/failed job
arq-optimus delete <job_id> --redis-url redis://localhost:6379

Using Key Prefix

# Via CLI flag
arq-optimus stats --redis-url redis://localhost:6379 --key-prefix myproject

# Or via environment variable
export ARQ_OPTIMUS_KEY_PREFIX=myproject
arq-optimus stats --redis-url redis://localhost:6379

REST API

The dashboard exposes a REST API:

Endpoint	Method	Description
/api/status	GET	Queue statistics
/api/jobs	GET	List jobs (query: ?status=running)
/api/jobs/count	GET	Job count by status
/api/jobs/{job_id}	GET	Job details
/api/jobs/{job_id}/cancel	POST	Cancel a job
/api/jobs/{job_id}	DELETE	Delete a job record

Job Tracking Setup

For the dashboard to track job status transitions (running → completed/failed), wrap your worker functions with tracking:

# arq_worker.py
from arq.connections import RedisSettings
from arq_optimus_dashboard.tracking import create_tracking_wrapper

async def my_task(ctx, arg):
    return f"processed {arg}"

class WorkerSettings:
    functions = [create_tracking_wrapper(my_task)]
    redis_settings = RedisSettings()
    key_prefix = 'myproject'

Django Integration

# settings.py
ARQ_OPTIMUS_KEY_PREFIX = 'my_project'

# arq_worker.py
from django.conf import settings
from arq.connections import RedisSettings
from arq_optimus_dashboard.tracking import create_tracking_wrapper

async def scrape_task(ctx, url):
    ...

class WorkerSettings:
    functions = [create_tracking_wrapper(scrape_task)]
    redis_settings = RedisSettings(host='redis.example.com', port=6379)
    key_prefix = getattr(settings, 'ARQ_OPTIMUS_KEY_PREFIX', '')

Compatibility

• Python: 3.9+
• Redis: 5, 6, 7+
• ARQ Optimus: 0.27.0+

Credits

Built on top of ARQ Optimus by Arpan Sahu.

License

MIT License