Configure your django-tasks-scheduler

settings.py

All default settings for scheduler can be in one dictionary in settings.py:

import os
from typing import Dict
from scheduler.types import SchedulerConfiguration, Broker, QueueConfiguration

SCHEDULER_CONFIG = SchedulerConfiguration(
    EXECUTIONS_IN_PAGE=20,
    SCHEDULER_INTERVAL=10,
    BROKER=Broker.REDIS,
    CALLBACK_TIMEOUT=60,  # Callback timeout in seconds (success/failure/stopped)
    # Default values, can be overridden per task/job
    DEFAULT_SUCCESS_TTL=10 * 60,  # Time To Live (TTL) in seconds to keep successful job results
    DEFAULT_FAILURE_TTL=365 * 24 * 60 * 60,  # Time To Live (TTL) in seconds to keep job failure information
    DEFAULT_JOB_TTL=10 * 60,  # Time To Live (TTL) in seconds to keep job information
    DEFAULT_JOB_TIMEOUT=5 * 60,  # timeout (seconds) for a job
    # General configuration values
    DEFAULT_WORKER_TTL=10 * 60,  # Time To Live (TTL) in seconds to keep worker information after last heartbeat
    DEFAULT_MAINTENANCE_TASK_INTERVAL=10 * 60,  # The interval to run maintenance tasks in seconds. 10 minutes.
    DEFAULT_JOB_MONITORING_INTERVAL=30,  # The interval to monitor jobs in seconds.
    SCHEDULER_FALLBACK_PERIOD_SECS=120,  # Period (secs) to wait before requiring to reacquire locks
    FAIL_FAST_QUEUE_PROBING=True,  # Use fail-fast connections when admin views probe every queue
    QUEUE_PROBE_SOCKET_CONNECT_TIMEOUT=2.0,  # Socket connect timeout (seconds) for those probes
)
SCHEDULER_QUEUES: Dict[str, QueueConfiguration] = {
    "default": QueueConfiguration(
        HOST="localhost",
        PORT=6379,
        USERNAME="some-user",
        PASSWORD="some-password",
        CONNECTION_KWARGS={  # Eventual additional Broker connection arguments
            "ssl_cert_reqs": "required",
            "ssl": True,
        },
    ),
    "high": QueueConfiguration(URL=os.getenv("REDISTOGO_URL", "redis://localhost:6379/0")),
    "low": QueueConfiguration(HOST="localhost", PORT=6379, DB=0, ASYNC=False),
}

SCHEDULER_CONFIG: EXECUTIONS_IN_PAGE

Number of job executions to show in a page in a ScheduledJob admin view.

Default: 20.

SCHEDULER_CONFIG: SCHEDULER_INTERVAL

Default scheduler interval, a scheduler is a subprocess of a worker and will check which job executions are pending.

Default: 10 (10 seconds).

SCHEDULER_CONFIG: BROKER

Broker to use, one of Broker.REDIS, Broker.VALKEY, Broker.FAKEREDIS.

Default: Broker.REDIS.

SCHEDULER_CONFIG: CALLBACK_TIMEOUT

Timeout (seconds) for a job callback (success/failure/stopped).

Default: 60 (1 minute).

SCHEDULER_CONFIG: DEFAULT_SUCCESS_TTL

Default time to live for job execution result when it is successful.

Default: 600 (10 minutes).

SCHEDULER_CONFIG: DEFAULT_FAILURE_TTL

Default time to live for job execution result when it is failed.

Default: 31536000 (365 days).

SCHEDULER_CONFIG: DEFAULT_JOB_TTL

Default timeout for job info.

Default: 600 (10 minutes).

SCHEDULER_CONFIG: DEFAULT_JOB_TIMEOUT

timeout (seconds) for a job.

Default: 300 (5 minutes).

SCHEDULER_CONFIG: DEFAULT_WORKER_TTL

Time To Live (TTL) in seconds to keep worker information after last heartbeat. Default: 600 (10 minutes).

SCHEDULER_CONFIG: DEFAULT_MAINTENANCE_TASK_INTERVAL

The interval to run worker maintenance tasks in seconds. Default: 600 10 minutes.

SCHEDULER_CONFIG: DEFAULT_JOB_MONITORING_INTERVAL

The interval to monitor jobs in seconds.

Default: 30 (30 seconds).

SCHEDULER_CONFIG: SCHEDULER_FALLBACK_PERIOD_SECS

Period (secs) to wait before requiring to reacquire locks.

Default: 120 (2 minutes).

SCHEDULER_CONFIG: FAIL_FAST_QUEUE_PROBING

Admin views that probe every configured queue for read-only operations (e.g. locating a job across queues, queue/worker statistics) use a short-timeout, no-retry connection by default, so a single unreachable queue cannot stall the request for several seconds (redis-py >= 8 retries connection errors with backoff by default). Set to False to use each queue's configured connection settings unmodified for these probes too, e.g. if retries are required even there.

Default: True.

SCHEDULER_CONFIG: QUEUE_PROBE_SOCKET_CONNECT_TIMEOUT

Socket connect timeout (seconds) applied to queue connections when FAIL_FAST_QUEUE_PROBING is enabled.

Default: 2.0.

SCHEDULER_CONFIG: TOKEN_VALIDATION_METHOD

Method to validate request Authorization header with. Enables checking stats using API token.

Default: no tokens allowed.

SCHEDULER_QUEUES

You can configure the queues to work with. That way you can have different workers listening to different queues.

Different queues can use different redis servers/connections.