Skip to content

Latest commit

 

History

History
147 lines (106 loc) · 5.08 KB

configuration.md

File metadata and controls

147 lines (106 loc) · 5.08 KB

Configuration

Global configuration

The plugin allows some simple runtime configuration. You may create a file called app_queue.php inside your config folder (NOT the plugins config folder) to set the following values:

  • Seconds to sleep() when no executable job is found:

    $config['Queue']['sleeptime'] = 10;

  • Probability in percent of an old job cleanup happening:

    $config['Queue']['gcprob'] = 10;

  • Default timeout after which a job is requeued if the worker doesn't report back:

    $config['Queue']['defaultworkertimeout'] = 1800;

  • Default number of retries if a job fails or times out:

    $config['Queue']['defaultworkerretries'] = 3;

  • Seconds of running time after which the worker will terminate (0 = unlimited):

    $config['Queue']['workermaxruntime'] = 120;

    Warning: Do not use 0 if you are using a cronjob to permanantly start a new worker once in a while and if you do not exit on idle.

  • Seconds of running time after which the PHP process of the worker will terminate (0 = unlimited):

    $config['Queue']['workertimeout'] = 120 * 100;

    Warning: Do not use 0 if you are using a cronjob to permanently start a new worker once in a while and if you do not exit on idle. This is the last defense of the tool to prevent flooding too many processes. So make sure this is long enough to never cut off jobs, but also not too long, so the process count stays in manageable range.

  • Should a worker process quit when there are no more tasks for it to execute (true = exit, false = keep running):

    $config['Queue']['exitwhennothingtodo'] = false;

  • Minimum number of seconds before a cleanup run will remove a completed task (set to 0 to disable):

    $config['Queue']['cleanuptimeout'] = 2592000; // 30 days

  • Max workers (per server):

    $config['Queue']['maxworkers'] = 3 // Defaults to 1 (single worker can be run per server)

  • Multi-server setup:

    $config['Queue']['multiserver'] = true // Defaults to false (single server)

    For multiple servers running either CLI/web separately, or even multiple CLI workers on top, make sure to enable this.

  • Use a different connection:

    $config['Queue']['connection'] = 'custom'; // Defaults to 'default'

  • Ignore certain task classes to they don't end up in the generated SQL query. Can be used to filter out the example tasks classes shipped with the plugin, if you're not using them:

    $config['Queue']['ignoredTasks'] = [
    'Queue\Queue\Task\CostsExampleTask',
    'Queue\Queue\Task\EmailTask',
    'Queue\Queue\Task\ExampleTask',
    'Queue\Queue\Task\ExceptionExampleTask',
    'Queue\Queue\Task\ExecuteTask',
    'Queue\Queue\Task\MonitorExampleTask',
    'Queue\Queue\Task\ProgressExampleTask',
    'Queue\Queue\Task\RetryExampleTask',
    'Queue\Queue\Task\SuperExampleTask',
    'Queue\Queue\Task\UniqueExampleTask',
]; // Defaults to []

Don't forget to load that config file with Configure::load('app_queue'); in your bootstrap. You can also use $this->addPlugin('Queue', ['bootstrap' => true]); which will load your app_queue.php config file automatically.

Example app_queue.php:

return [
    'Queue' => [
        'workermaxruntime' => 60,
        'sleeptime' => 15,
    ],
];

You can also drop the configuration into an existing config file (recommended) that is already been loaded. The values above are the default settings which apply, when no configuration is found.

Backend configuration

  • isSearchEnabled: Set to false if you do not want search/filtering capability. This is auto-detected based on Search plugin being available/loaded if not disabled.

  • isStatsEnabled: Set to true to enable. This requires chart.js asset to be available. You can also overwrite the template and as such change the asset library as well as the output/chart.

Configuration tips

For the beginning maybe use not too many runners in parallel, and keep the runtimes rather short while starting new jobs every few minutes. You can then always increase spawning of runners if there is a shortage.

Task configuration

You can set two main things on each task as property: timeout and retries.

    /**
     * Timeout for this task in seconds, after which the task is reassigned to a new worker.
     *
     * @var int
     */
    public $timeout = 120;

    /**
     * Number of times a failed instance of this task should be restarted before giving up.
     *
     * @var int
     */
    public $retries = 1;

Make sure you set the timeout high enough so that it could never run longer than this, otherwise you risk it being re-run while still being run. It is recommended setting it to at least 2x the maximum possible execution length. See Concurrent workers

Set the retries to at least 1, otherwise it will never execute again after failure in the first run.