Features¶
Welcome to the Features section of the AsyncMQ documentation! Here you’ll find detailed guides on each core capability of AsyncMQ. Click through to learn how to wield each feature like a pro:
-
Settings & Configuration Centralized, type-safe, and environment‑driven configuration for backends, concurrency, rate limits, sandboxing, TTL, and more.
-
Logging Pluggable logging setup via
LoggingConfig
, with a default console implementation and examples for custom JSON or file‑based handlers. -
Tasks &
@task
Decorator Define async or sync functions as background jobs, enqueue them with ease, report progress, chain dependencies, and schedule repeats. -
Queues &
Queue
API High‑level interface to enqueue jobs (single, bulk, delayed, repeatable), pause/resume processing, inspect state, clean up old jobs, and start workers. -
Workers & Processing Loops The heart of AsyncMQ: concurrency and rate limiting, job lifecycle management (
process_job
andhandle_job
), events, retries, and theWorker
helper. -
Runners & Worker Entrypoints Core runner functions (
worker_loop
,start_worker
, andrun_worker
) that tie together concurrency, rate limiting, delayed scans, and repeatable scheduling. -
Schedulers & Cron Utilities Metronomes for your jobs: the
repeatable_scheduler
loop, dynamic sleep logic,compute_next_run
, and trade‑offs between cron expressions and fixed intervals. -
Sandboxed Execution Isolate untrusted or heavy tasks in subprocesses, enforce timeouts, capture errors safely, and optionally fall back to inline execution.
-
Jobs &
Job
Class The atomic unit of work: states, TTL checks, retry/backoff strategies, serialization (to_dict
/from_dict
), dependencies, and repeatable metadata. -
Flows &
FlowProducer
Orchestrate multi‑step pipelines or DAGs: atomic enqueue of job graphs with dependencies, fallback logic, and backend‑optimized operations. -
CLI Reference Your terminal command center for queue and job inspection, worker startup, pausing/resuming queues, retrying or cancelling jobs, and viewing backend info.
-
Performance Tuning & Benchmarking In‑depth strategies and examples for measuring throughput, tuning concurrency and rate limits, optimizing scan intervals, and backend‑specific best practices.
-
Security & Compliance Lock down your pipelines with authentication, encryption, ACLs, audit logging, and compliance guidance (GDPR, HIPAA, PCI DSS).
Navigate to any feature above to dive deep—each guide is packed with examples, best practices, troubleshooting tips, and a dash of humor to keep you smiling as you build robust, scalable background job systems with AsyncMQ.