To monitor queued tasks in Laravel's Telescope, you need to manually add the listening event. 1. Open the app/Providers/TelescopeServiceProvider.php file; 2. Introduce and listen to the JobQueued event in the register() method; 3. After the configuration is completed, under the Jobs tag of Telescope, you can view the detailed information of the queued job, including the task class name, queue name and enqueue parameters. This method is suitable for Redis or database-driven queues and supports monitoring of delayed tasks. Note that filtering rules and data security policies should be set reasonably in the online environment to avoid performance problems and sensitive information leakage.

If you are using Laravel's Telescope to monitor queued tasks, especially if you want to view queued tasks, you may find that by default Telescope does not record tasks with these states. This can make troubleshooting or debugging the task process a little cumbersome.

To enable Telescope to monitor queued jobs, some small configuration adjustments are required.

Modify the recording rules of Telescope

By default, Telescope only records processed, failed, and deleted tasks. To also record the queued tasks, you need to modify the listening logic in TelescopeServiceProvider .

Find register() method in app/Providers/TelescopeServiceProvider.php file and add the listening to JobProcessing event:

 use Illuminate\Support\Facades\Bus;
use Illuminate\Queue\Events\JobQueued;

public function register()
{
    $this->hideSensitiveRequestDetails();

    Telescope::filter(function (IncomingEntry $entry) {
        if ($this->app->isLocal()) {
            return true;
        }

        return false;
    });

    // Add this line to listen for the JobQueued event Telescope::listen([
        \Illuminate\Queue\Events\JobQueued::class,
    ]);
}

In this way, when the task is pushed into the queue, it will be captured and recorded by Telescope.

View queued job in Telescope interface

After the configuration is completed, when you trigger a task enqueue operation, you can see the corresponding record under the Jobs tab of Telescope. Each record displays the task class name, connection name, queue name, and serialized task data.

Click on a record to view details, including task parameters, enlistment time and other information. This is very helpful for whether the debugging task is successfully enqueued and whether the parameters are correct.

Note: If you are using Redis or database-driven queues and have set up delay tasks, Telescope can also capture these queued jobs.

FAQs and Suggestions

• Queue environment restrictions : Telescope is enabled only in the local environment by default, and online environments are usually turned off. If you want to record some logs online, remember to control the filtering rules reasonably to avoid performance impact.
• Data Security : Tasks may contain sensitive data, such as user ID or mailbox. It is important to be careful not to record sensitive fields in production environments. You can block certain fields through the $telescope->hidden() method.
• Task duplication record : Some tasks may be enqueued multiple times, resulting in multiple records in Telescope. Deduplication can be performed by task ID or custom identification.

Basically that's it. Just add a listening event and you can use Telescope to view the queued job. It is not complicated but easy to ignore. Under the default settings, tasks that cannot be seen with queued status, just make up for it manually.

The above is the detailed content of Monitoring Queued Jobs Telescope | Queue Inspection. For more information, please follow other related articles on the PHP Chinese website!