Queue worker supervision in Laravel - Mini Project: Build & Apply

Queue Worker Supervision in Laravel

📖 Scenario: You are building a Laravel application that processes tasks in the background using queue workers. To keep your application reliable, you want to supervise these queue workers so they restart automatically if they fail or stop unexpectedly.

🎯 Goal: Set up a supervised queue worker in Laravel using the queue:work command with a process monitor to ensure the worker restarts automatically if it stops.

📋 What You'll Learn

Create a Laravel command to run the queue worker

Define a supervisor configuration variable for the worker

Use the queue:work command with the --tries option

Add a process monitor command to restart the worker automatically

💡 Why This Matters

🌍 Real World

Supervising queue workers ensures background jobs run reliably without manual restarts, which is critical for applications processing emails, notifications, or data imports.

💼 Career

Understanding queue worker supervision is important for backend developers and DevOps engineers to maintain application uptime and handle background job failures gracefully.

1

Create a Laravel command to run the queue worker

Create a Laravel Artisan command called queue:work that runs the queue worker using php artisan queue:work.

Laravel

# Create the command to run the queue worker
# Your code here

Hint

Use php artisan make:command RunQueueWorker to create the command, then set $signature and call queue:work inside handle().

2

Define a supervisor configuration variable for the worker

Add a protected variable called $tries in the RunQueueWorker command class and set it to 3 to limit the number of attempts for failed jobs.

Laravel

call('queue:work');
    }
}

Hint

Define protected $tries = 3; inside the command class but outside any method.

3

Use the queue:work command with the --tries option

Modify the handle() method in the RunQueueWorker command to call queue:work with the --tries=3 option using $this->call().

Laravel

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class RunQueueWorker extends Command
{
    protected $signature = 'queue:work';
    protected $description = 'Run the Laravel queue worker';
    protected $tries = 3;

    public function handle()
    {
        // Call queue:work with --tries=3
        # Your code here
    }
}

Hint

Use $this->call('queue:work', ['--tries' => 3]); inside the handle() method.

4

Add a process monitor command to restart the worker automatically

Add a supervisor configuration command in config/queue.php under 'supervisor' key with 'command' => 'php artisan queue:work --tries=3' to supervise the queue worker process.

Laravel

<?php

return [
    // Add supervisor configuration here
    # Your code here
];

Hint

In config/queue.php, add a 'supervisor' array with a 'command' key set to 'php artisan queue:work --tries=3'.

Practice

1. What is the main purpose of using Supervisor with Laravel queue workers?

easy

A. To automatically restart queue workers if they stop unexpectedly

B. To speed up the execution of queue jobs

C. To log all queue jobs to a database

D. To convert queue jobs into synchronous tasks

Solution

1. Step 1: Understand Supervisor's role

   Supervisor monitors processes and restarts them if they stop.

2. Step 2: Apply this to Laravel queue workers

   Laravel queue workers run background jobs; Supervisor ensures they keep running.

3. Final Answer:

   To automatically restart queue workers if they stop unexpectedly -> Option A

4. Quick Check:

   Supervisor restarts workers automatically [OK]

Hint: Supervisor restarts stopped workers automatically [OK]

Common Mistakes:

• Thinking Supervisor speeds up job execution
• Confusing logging with supervision
• Believing Supervisor makes jobs synchronous

2. Which of the following is the correct Supervisor configuration directive to specify the command to run a Laravel queue worker?

easy

A. run=php artisan queue:work

B. command=php artisan queue:work

C. execute=php artisan queue:work

D. start=php artisan queue:work

Solution

1. Step 1: Recall Supervisor config syntax

   Supervisor uses 'command=' to specify the process command.

2. Step 2: Match with Laravel queue worker command

   Laravel queue worker runs with 'php artisan queue:work'.

3. Final Answer:

   command=php artisan queue:work -> Option B

4. Quick Check:

   Supervisor uses 'command=' for process commands [OK]

Hint: Supervisor config uses 'command=' for commands [OK]

Common Mistakes:

• Using 'run=' instead of 'command='
• Confusing 'execute=' or 'start=' as valid directives
• Omitting the full artisan command

3. Given this Supervisor config snippet:

[program:laravel-worker]
command=php /var/www/artisan queue:work --sleep=3 --tries=3
numprocs=1
autostart=true
autorestart=true
user=www-data

What happens if the Laravel queue worker process crashes?

medium

A. Supervisor will restart the worker automatically

B. The worker will remain stopped until manually restarted

C. Supervisor will log the crash but not restart the worker

D. The worker will restart only if autostart is false

Solution

1. Step 1: Check 'autorestart' setting

   autorestart=true means Supervisor restarts crashed processes automatically.

2. Step 2: Understand autostart role

   autostart=true means the worker starts on Supervisor start, but restart depends on autorestart.

3. Final Answer:

   Supervisor will restart the worker automatically -> Option A

4. Quick Check:

   autorestart=true means auto restart on crash [OK]

Hint: autorestart=true means auto restart on crash [OK]

Common Mistakes:

• Confusing autostart with autorestart
• Assuming manual restart is needed
• Thinking Supervisor only logs crashes

4. You configured Supervisor to run Laravel queue workers but notice workers are not restarting after failure. Which of these is the most likely cause?

medium

A. The 'numprocs' option is set to 0

B. The 'command' option is missing the '--tries' flag

C. The 'user' option is set to 'root'

D. The 'autorestart' option is set to false or missing

Solution

1. Step 1: Identify why workers don't restart

   Workers won't restart if 'autorestart' is false or missing.

2. Step 2: Check other options' impact

   'numprocs=0' disables processes, 'user=root' is allowed but not recommended, '--tries' controls job retries, not restarts.

3. Final Answer:

   The 'autorestart' option is set to false or missing -> Option D

4. Quick Check:

   autorestart=false stops auto restart [OK]

Hint: Check 'autorestart' to fix no restart issue [OK]

Common Mistakes:

• Confusing job retry with process restart
• Thinking 'user=root' causes restart failure
• Assuming '--tries' affects Supervisor restart

5. You want to run multiple Laravel queue workers supervised by Supervisor to handle high job volume. Which configuration change is best to achieve this?

hard

A. Set 'numprocs' to 1 and increase '--sleep' time in the command

B. Create multiple Supervisor config files each with one worker and same program name

C. Set 'numprocs' to the number of workers needed and use '%(program_name)s_%(process_num)s' in 'process_name'

D. Use 'autostart=false' and manually start each worker process

Solution

1. Step 1: Understand running multiple workers

   Supervisor can run multiple processes with 'numprocs' and unique names.

2. Step 2: Use 'process_name' for unique worker IDs

   Using '%(program_name)s_%(process_num)s' creates unique names for each worker.

3. Final Answer:

   Set 'numprocs' to the number of workers needed and use '%(program_name)s_%(process_num)s' in 'process_name' -> Option C

4. Quick Check:

   Multiple workers = numprocs + unique process_name [OK]

Hint: Use numprocs and unique process_name for multiple workers [OK]

Common Mistakes:

• Duplicating config files with same program name
• Increasing sleep time reduces throughput
• Disabling autostart prevents automatic worker start