Skip to content

Commit 1f8439f

Browse files
committed
doc:update readme
1 parent 1b2d4f9 commit 1f8439f

File tree

1 file changed

+43
-15
lines changed

1 file changed

+43
-15
lines changed

docs/configuration.md

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import os
99
from typing import Dict
1010
from scheduler.types import SchedulerConfiguration, Broker, QueueConfiguration
1111

12-
1312
SCHEDULER_CONFIG = SchedulerConfiguration(
1413
EXECUTIONS_IN_PAGE=20,
1514
SCHEDULER_INTERVAL=10,
@@ -48,23 +47,58 @@ Number of job executions to show in a page in a ScheduledJob admin view.
4847

4948
Default: `20`.
5049

51-
### SCHEDULER_CONFIG: `DEFAULT_RESULT_TTL`
50+
### SCHEDULER_CONFIG: `SCHEDULER_INTERVAL`
51+
52+
Default scheduler interval, a scheduler is a subprocess of a worker and
53+
will check which job executions are pending.
54+
55+
Default: `10` (10 seconds).
56+
57+
### SCHEDULER_CONFIG: `BROKER`
5258

53-
Default time to live for job execution result.
59+
### SCHEDULER_CONFIG: `CALLBACK_TIMEOUT`
60+
61+
### SCHEDULER_CONFIG: `DEFAULT_SUCCESS_TTL`
62+
63+
Default time to live for job execution result when it is successful.
64+
65+
Default: `600` (10 minutes).
66+
67+
### SCHEDULER_CONFIG: `DEFAULT_FAILURE_TTL`
68+
69+
Default time to live for job execution result when it is failed.
5470

5571
Default: `600` (10 minutes).
5672

57-
### SCHEDULER_CONFIG: `DEFAULT_TIMEOUT`
73+
### SCHEDULER_CONFIG: `DEFAULT_JOB_TTL`
74+
75+
Default timeout for job info.
5876

59-
Default timeout for job when it is not mentioned in queue.
6077
Default: `300` (5 minutes).
6178

62-
### SCHEDULER_CONFIG: `SCHEDULER_INTERVAL`
79+
### SCHEDULER_CONFIG: `DEFAULT_JOB_TIMEOUT`
6380

64-
Default scheduler interval, a scheduler is a subprocess of a worker and
65-
will check which job executions are pending.
81+
timeout (seconds) for a job.
6682

67-
Default: `10` (10 seconds).
83+
Default: `300` (5 minutes).
84+
85+
### SCHEDULER_CONFIG: `DEFAULT_WORKER_TTL`
86+
87+
Time To Live (TTL) in seconds to keep worker information after last heartbeat.
88+
Default: `600` (10 minutes).
89+
90+
### SCHEDULER_CONFIG: `DEFAULT_MAINTENANCE_TASK_INTERVAL`
91+
92+
The interval to run worker maintenance tasks in seconds.
93+
Default: `600` 10 minutes.
94+
95+
### SCHEDULER_CONFIG: `DEFAULT_JOB_MONITORING_INTERVAL`
96+
97+
The interval to monitor jobs in seconds.
98+
99+
### SCHEDULER_CONFIG: `SCHEDULER_FALLBACK_PERIOD_SECS`
100+
101+
Period (secs) to wait before requiring to reacquire locks.
68102

69103
### SCHEDULER_CONFIG: `TOKEN_VALIDATION_METHOD`
70104

@@ -73,12 +107,6 @@ Enables checking stats using API token.
73107

74108
Default: no tokens allowed.
75109

76-
### SCHEDULER_CONFIG: `BROKER`
77-
78-
Broker driver to use for the scheduler. Can be `redis` or `valkey` or `fakeredis`.
79-
80-
Default: `redis`.
81-
82110
### `SCHEDULER_QUEUES`
83111

84112
You can configure the queues to work with.

0 commit comments

Comments
 (0)