Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The number of signals before a hard kill can be configured with the `--hardkill-
* `--log-format` is used to set a log format (default `%(asctime)s][%(name)s][%(levelname)-7s][%(processName)s] %(message)s`).
* `--max-async-tasks` - maximum number of simultaneously running async tasks.
* `--max-async-tasks-jitter` – Randomly varies the max async task limit between --max-async-tasks and a jittered value, helping prevent simultaneous worker restarts.
* `--max-prefetch` - number of tasks to be prefetched before execution. (Useful for systems with high message rates, but brokers should support acknowledgements).
* `--max-prefetch` - maximum number of deliveries allowed to wait for execution beyond the available async execution capacity. With a finite `--max-async-tasks` limit, a worker admits at most its effective async execution limit plus `max_prefetch` running or waiting deliveries. The default `0` disables additional buffering, and the value must be non-negative. This option is useful for systems with high message rates, but brokers should support acknowledgements.
* `--max-threadpool-threads` - number of threads for sync function execution.
* `--no-propagate-errors` - if this parameter is enabled, exceptions won't be thrown in generator dependencies.
* `--receiver` - python path to custom receiver class.
Expand Down
3 changes: 2 additions & 1 deletion taskiq/api/receiver.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ async def run_receiver_task(
:param validate_params: whether to validate params or not.
:param max_async_tasks: maximum number of simultaneous async tasks.
:param max_async_tasks_jitter: random jitter to add to max_async_tasks.
:param max_prefetch: maximum number of tasks to prefetch.
:param max_prefetch: maximum number of deliveries allowed to wait beyond
the available async execution capacity. Must be non-negative.
:param propagate_exceptions: whether to propagate exceptions in generators or not.
:param run_startup: whether to run startup function or not.
:param ack_time: acknowledge type to use.
Expand Down
5 changes: 4 additions & 1 deletion taskiq/cli/worker/args.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,10 @@ def from_cli(
type=int,
dest="max_prefetch",
default=0,
help="Maximum prefetched tasks per worker process. ",
help=(
"Maximum deliveries waiting beyond async execution capacity. "
"Must be non-negative. "
),
)
parser.add_argument(
"--no-configure-logging",
Expand Down
Loading
Loading