Skip to content

Commit

Permalink
Add missing CLI options documentation (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
stinovlas authored Dec 5, 2023
1 parent eaf704e commit 11bebcc
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,15 @@ when you modify ignored files. To disable this functionality pass `--do-not-use-
### Other parameters

* `--no-configure-logging` - disables default logging configuration for workers.
- `--log-level` is used to set a log level (default `INFO`).
* `--max-async-tasks` - maximum number of simultaneously running async tasks.
* `--max-prefetch` - number of tasks to be prefetched before execution. (Useful for systems with high message rates, but brokers should support acknowledgements).
* `--max-threadpool-threads` - number of threads for sync function exection.
* `--no-propagate-errors` - if this parameter is enabled, exceptions won't be thrown in generator dependencies.
* `--receiver` - python path to custom receiver class.
* `--receiver_arg` - custom args for receiver.
* `--ack-type` - Type of acknowledgement. This parameter is used to set when to acknowledge the task. Possible values are `when_received`, `when_executed`, `when_saved`. Default is `when_saved`.
- `--shutdown-timeout` - maximum amount of time for graceful broker's shutdown in seconds.

## Scheduler

Expand All @@ -118,4 +120,6 @@ Path to scheduler is the only required argument.
- `--tasks-pattern` or `-tp`.
It's a name of files to import. By default is searches for all `tasks.py` files.
- `--fs-discover` or `-fsd`. This option enables search of task files in current directory recursively, using the given pattern.
- `--log-level` is used to set a log level.
- `--no-configure-logging` - use this parameter if your application configures custom logging.
- `--log-level` is used to set a log level (default `INFO`).
- `--skip-first-run` - skip first run of scheduler. This option skips running tasks immediately after scheduler start.

0 comments on commit 11bebcc

Please sign in to comment.