Průvodce používáním kontextu Laravel k přidávání dalších informací k úlohám

Laravel Kontext poskytuje vynikající způsob, jak zachytit a sdílet metadata v rámci požadavků, úloh a příkazů v aplikaci. To umožňuje sledovat důležité informace, jako jsou ID uživatelů, adresy URL nebo ID trasování, a automaticky je vkládat do protokolů a úloh. To může být neocenitelné při ladění, monitorování a sledování toku dat v distribuovaných systémech.

V této příručce se zaměříme na to, jak funkce kontextu v systému Laravel umožňuje přidávat k úlohám další informace, což usnadňuje sledování a ladění procesů na pozadí.

Jak kontext Laravel pracuje s úlohami

Kontextová funkce Laravelu funguje tak, že zachycuje data v rámci kontext a následné přiřazení těchto dat ke konkrétním úlohám nebo akcím v aplikaci. Při odeslání úlohy jsou kontextová data automaticky sdílena s touto úlohou. To znamená, že všechny informace v kontextu jsou během provádění úlohy k dispozici.

Rozebereme si to na příkladu.

1. Přidání kontextu do požadavku

Nejprve zachytíme některé informace během příchozího požadavku pomocí middlewaru. Zde budeme ukládat data, která budou později předána úlohám při jejich odesílání.

namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Context;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;
 
class AddContext
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next): Response
    {
        // Add URL and trace ID to the context
        Context::add('url', $request->url());
        Context::add('trace_id', Str::uuid()->toString());
 
        return $next($request);
    }
}

Ve výše uvedeném middlewaru přidáváme adresu URL požadavku a jedinečné ID stopy do kontextu každého příchozího požadavku.

2. Odesílání úlohy s kontextem

Po přidání kontextu můžete úlohu odeslat běžným způsobem. Kontextová data budou automaticky předána spolu s úlohou:

// In our controller...
ProcessPodcast::dispatch($podcast);

Informace o kontextu, které byly přidány během požadavku, budou zahrnuty při odeslání úlohy. Laravel automaticky zpracuje dehydratace (zachycení kontextu) a hydratace (obnovení kontextu) těchto informací.

3. Přístup ke kontextu v úloze

Uvnitř úlohy jsou kontextová data k dispozici stejně jako během požadavku. Zde je uvedeno, jak můžete ke kontextu přistupovat v rámci úlohy handle() metoda:

use Illuminate\Support\Facades\Log;
 
class ProcessPodcast implements ShouldQueue
{
    use Queueable;
 
    // ...
 
    /**
     * Execute the job.
     */
    public function handle(): void
    {
        Log::info('Processing podcast.', [
            'podcast_id' => $this->podcast->id,
        ]);
 
        // Job logic
    }
}

Při provádění úlohy Laravel automaticky zahrne kontextové informace, které byly zachyceny během požadavku. Výsledný záznam v protokolu může vypadat takto:

Processing podcast. {"podcast_id":95} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

Tento protokol obsahuje jak údaje specifické pro danou úlohu (podcast_id) a kontextová data (url a trace_id), což umožňuje bezproblémově sledovat provádění požadavku a úlohy společně.

Praktické výhody používání kontextu s pracovními místy

1. Zlepšená sledovatelnost: Díky automatickému sdílení kontextu s úlohami můžete sledovat tok požadavků prostřednictvím procesů na pozadí a pochopit, jak jsou různé akce vzájemně propojeny.

2. Lepší ladění: Přístup ke kontextu v protokolech a úlohách usnadňuje ladění problémů, protože máte větší přehled o prostředí a datech, která provázejí každé provedení úlohy.

3. Bezproblémové monitorování: Kontextové informace usnadňují sledování stavu a výkonu úloh, protože můžete korelovat protokoly a provedení úloh pomocí konzistentních metadat, jako jsou ID trasování.

Závěr

Laravel Kontext nabízí efektivní způsob přidávání a správy metadat v rámci úloh. Automatickým sdílením kontextových dat během životního cyklu úlohy můžete zlepšit sledovatelnost, ladění a monitorování úloh na pozadí. Ať už potřebujete předat jednoduché informace, jako jsou adresy URL, nebo složitější údaje, jako jsou ID trasování, funkce kontextu Laravelu zajistí, že všechny relevantní údaje budou k dispozici všude, kde je budete potřebovat.

Začněte používat Laravel Context ještě dnes a získejte lepší přehled o provádění úloh a zlepšete robustnost své aplikace!