Debugging Laravel jobs

Question

I am trying to debug jobs on a queue in Laravel but to no success. I want to print output into the console. Such as how you use dd() everywhere else.

<?php

namespace App\Jobs;

use App\Image;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;

class ProcessImage implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    protected $image;

    /**
     * Attempt the job a maximum of twice
     *
     * @var int
     */
    public $tries = 2;

    /**
     * Create a new job instance.
     *
     * @return void
     */
    public function __construct(Image $image)
    {

        $this->image = $image;

    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        // set paths for standard and thumbnail size images

        $image          = public_path("assets" . DIRECTORY_SEPARATOR . $this->image->original);
        $product_id     = $this->image->id;
        $product_path   = public_path("assets" . DIRECTORY_SEPARATOR . "images" . DIRECTORY_SEPARATOR .
            "products" . DIRECTORY_SEPARATOR . $product_id);


        $thumbnail_path = $product_path . DIRECTORY_SEPARATOR . "thumbnail";

        if(!is_dir($product_path))
            mkdir($product_path);

        if(!is_dir($thumbnail_path))
            mkdir($thumbnail_path);

        // Resize and save the standard image

        $standard = \Image::make($image)->resize(450, 450, function($constraint)
        {
            $constraint->aspectRatio();
        })->save($product_path);

        dd($standard);

    }
}

If you want to debug the code you will need to assemble your command string that starts artisan accordingly like so - php -dxdebug.remote_autostart=1 artisan queue:work (source: https://medium.com/@kebing.yu/make-xdebug-work-with-laravel-queue-b5e73e44a36b) — Daniel Protopopov, Apr 14 '18 at 15:06

score 21 · Answer 1 · answered Apr 14 '18 at 14:22

21

1) Try php artisan queue:restart - if you're running queue as a daemon, you need to restart listener every time your code changes as the daemon loads code into memory.

2) var_dump() dd() and Log::info() should be working in queues. Make sure you debug gradually - log at the very beginning of job, then a little lower, lower still, etc. and see what's the last point you get logged out.

3) Check laravel.log under storage/logs - the error should be logged out somewhere.

answered Apr 14 '18 at 14:22

Criss

952
5
17

1

Seems that it is getting logged in storage/logs, however I would expect a way to output to the console while the job is running, I assumed it would be based upon console. – Ian Apr 14 '18 at 14:31
How are you running your queue listener? `php artisan queue:work`? What parameters are you passing? – Criss Apr 14 '18 at 14:35
If you are using sail : `sail php artisan queue:restart` – Jeffrey Nicholson Carré Nov 17 '22 at 00:48

score 9 · Answer 2 · answered Sep 07 '20 at 05:43

9

If you want to debug Laravel Job with PHP Storm edit .env file:

QUEUE_DRIVER=sync

Put a breakpoint in the handle() function.

answered Sep 07 '20 at 05:43

yesnik

4,085
2
30
25

score 5 · Answer 3 · edited Apr 15 '21 at 10:36

5

you don't need to print it on the console. full description of fail job is store in the exception column.(table name fail_jobs).

edited Apr 15 '21 at 10:36

Syscall

19,327
10
37
52

answered Apr 14 '21 at 17:48

FAZAL HAKIM

89
1
5

Mine was empty despite having spent days of purposely failing and debugging the jobs, so this doesn't seem to work. – Hashim Aziz Feb 27 '22 at 21:08

score 3 · Answer 4 · answered Apr 14 '18 at 14:10

3

What I do is I Log information that needs to be seen, like in your case:

\Log::info('Making new directory');

Or

\Log::info('this is new image: ', [$standard]);

and so on. just open the log info and see where the code breaks or the condition that should be working didn't work.

answered Apr 14 '18 at 14:10

Muhammad Nauman

1,249
8
10

1

I have tried this, however I don't get any output. https://i.imgur.com/QvMwGE6.png – Ian Apr 14 '18 at 14:11
Yes there are Muhammad – Ian Apr 14 '18 at 15:06
This won't output in the log file. – Shah-Kodes May 04 '20 at 15:32
1

Will you please explain why this will not work? @Shah-Kodes – Muhammad Nauman May 05 '20 at 10:51
Worked for me in case if you use the sync driver. See `'default' => env('QUEUE_CONNECTION', 'sync')` line in queue.php file – Armalong Apr 09 '21 at 11:20
Outputted to Laravel log file fine for me on Laravel 8 with the default settings. – Hashim Aziz Feb 27 '22 at 21:12

score 0 · Answer 5 · answered Dec 02 '21 at 11:43

I did it in two ways:

Using Cache facade with method put(). And next, you can get this with Cache::get($cacheKey);. Here I can pass any data type: Collections, arrays, integer, string, etc.
Using Log facade with method debug(). The First parameter is the message and the second is context only with array type.

The first variant is easier for debugging various data, but the second is easier for getting debug info. I prefer the first variant :)

score 0 · Answer 6 · answered Sep 27 '22 at 04:11

0

I use print_r() which can do the job.

answered Sep 27 '22 at 04:11

Thomas Lo

76
1
6

Debugging Laravel jobs

6 Answers6