Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 2.06 KB

misc.md

File metadata and controls

65 lines (49 loc) · 2.06 KB
Raw

Misc

Logging

By default, errors are always logged, and with log enabled also the execution of a job. Make sure you add this to your config:

'Log' => [
    ...
    'queue' => [
        'className' => ...,
        'type' => 'queue',
        'levels' => ['info'],
        'scopes' => ['queue'],
    ],
],

When debugging (not using --quiet/-q) on "run", it will also log the worker run and end.

You can disable info logging by setting Queue.log to false in your config.

Resetting

You can reset all failed jobs from CLI and web backend. With web backend you can reset specific ones, as well.

From CLI you run this to reset all at once:

bin/cake queue reset

Rerunning

You can rerun successfully run jobs if they are not yet cleaned out. Make sure your cleanup timeout is high enough here. Usually weeks or months is a good balance to have those still stored for this case.

This is especially useful for local development or debugging, though. As you would otherwise have to manually trigger or import the job all the time.

From CLI you run this to rerun all of a specific job type at once:

bin/cake queue rerun FooBar

You can add a reference to rerun a specific job.

Using custom finder

You can use a convenience finder for tasks that are still queued, that means not yet finished.

$queuedJobsTable = $this->fetchTable('Queue.QueuedJobs');
$query = $queuedJobsTable->find('queued')->...;

This includes also failed ones if not filtered further using where() conditions.

Notes

<TaskName> is the complete class name without the Task suffix (e.g. Example or PluginName.Example).

Custom tasks should be placed in src/Queue/Task/. Tasks should be named SomethingTask and implement the Queue "Task".

Plugin tasks go in plugins/PluginName/src/Queue/Task/.

A detailed Example task can be found in src/Queue/Task/QueueExampleTask.php inside this plugin.

Some more tips:

  • If you copy an example, do not forget to adapt the namespace ("App")!
  • For plugin tasks, make sure to load the plugin using the plugin prefix ("MyPlugin.MyName").