Hantera Laravel-arbetsköer med Beanstalk och Supervisor på Ubuntu 16.04

Beanstalk är en snabb och enkel arbetskö. Det låter dig köra tidskrävande uppgifter asynkront, som att skicka e-post, ansluta till externa API:er eller bearbeta bilder. Genom att göra det minskar du din webbapps latens. Laravel ger direkt support för beanstalkd.

I den här handledningen kommer vi att installera beanstalkd, konfigurera en demo Laravel-applikation och hantera köarbetarna genom Supervisor . Demoapplikationen kommer att få en lista över tillgängliga operativsystem från Vultr API och slumpmässigt välja ett.

Det antas att du redan har Supervisor installerad på ditt system. Om du inte gör det bör du läsa följande handledning om hur du ställer in Supervisor: Installera och konfigurera Supervisor på Ubuntu 16.04

Det antas också att du har SSH-åtkomst till din Vultr-instans.

Installera Beanstalk

Det första steget att ta är att installera beanstalkd.

sudo apt-get update
sudo apt-get install beanstalkd

Starta tjänsten.

sudo systemctl start beanstalkd

Du kan också aktivera tjänsten att starta vid systeminitiering.

sudo systemctl enable beanstalkd

Kontrollera tjänstens status genom att utfärda följande kommando.

sudo systemctl status beanstalkd

Som standard beanstalkdlyssnar på porten 11300. Beanstalk använder ett enkelt textbaserat protokoll som beskrivs i dess github-förråd . Du kan testa dess protokoll genom att köra telnet.

telnet localhost 11300

Skriv följande och tryck på ENTER.

list-tubes

Du bör se en lista över tillgängliga tuber på servern:

OK 14
---
- default

För att stänga anslutningen skriver du bara quitoch trycker på ENTER.

Rör i Beanstalk representerar arbetsköer. Bönstjälk består huvudsakligen av producenter , konsumenter , jobb och rör . Producenterna lägger jobb i ett rör för att konsumeras (bearbetas) av ett valfritt antal konsumenter. Observera att både producenter och konsumenter helt enkelt är kunder till Beanstalk-servern och är helt oberoende av varandra. Rent praktiskt betyder detta att du genom att använda Beanstalk kan producera dina jobb i din PHP-applikation och få dem bearbetade i till exempel en NodeJS-app. Lyckligtvis abstraherar Laravel allt detta och ger oss ett mycket enkelt API för att skicka och hantera jobb, som vi kommer att se härnäst.

Exempel på projekt

För att bygga vårt exempelprojekt måste vi först installera dess beroenden. Vi kommer att installera PHP och Composer.

sudo apt-get install php php-mbstring php-xml php-common php-zip composer

Skapa nu projektet baserat på Laravel 5.5.

composer create-project --prefer-dist laravel/laravel vultr "5.5.*"

Nästa cdtill den nyligen skapade mappen. Vi kommer att arbeta i den här katalogen från och med nu. Denna mapp kan hänvisas till senare som PROJECT_ROOT.

cd vultr/

För att använda Beanstalk i Laravel måste vi installera ytterligare ett beroende, PHP Beanstalk-klienten.

composer require pda/pheanstalk ~3.0

Vi måste också skapa en jobbrepresentation. I Laravel är detta en klass inne i app/Jobsmappen. Laravel har ett konsolkommando som hjälper oss att skapa en jobbklass. Låt oss skapa vårt exempeljobb.

php artisan make:job FindFavoriteOS

Uppdatera app/Jobs/FindFavoriteOS.phpfilen till följande.

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Support\Facades\Log;

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

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

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        $rawData = file_get_contents('https://api.vultr.com/v1/os/list');
        $list = json_decode($rawData, true);
        shuffle($list);
        $key = array_rand($list);
        $favorite = $list[$key];
        Log::info('My Favorite OS is: ' . $favorite['name']);
    }
}

Hanteringsmetoden är vad som kommer att utföras effektivt när jobbet är förbrukat. Här hämtar vi data från Vultr API, väljer ett OS slumpmässigt och skriver det valda OS till loggfilen. Loggfilen finns på storage/logs/laravel.log.

Vi har redan installerat Beanstalk och definierat jobbet som ska utföras av det. Nu är det dags att berätta för Laravel att använda Beanstalk som standardarbetskö. Kopiera standardfilen som .envtillhandahålls av Laravel-installationen.

cp .env.example .env

Öppna nu .envfilen och uppdatera raden där ködrivrutinen är angiven.

QUEUE_DRIVER=beanstalkd

Till sist, generera en applikationsnyckel.

php artisan key:generate

Vi är nu redo att skicka jobb till Beanstalks arbetskö.

Utskick och kör jobb

Att skicka ett jobb i Laravel är ganska enkelt. Uppdatera routes/web.phpfilen.

<?php

Route::get('/', function () {
    for ($i = 0; $i < 50; $i++) {
        \App\Jobs\FindFavoriteOS::dispatch();
    }

    return '50 Jobs dispatched!';
});

Trots att vi inte rekommenderas att köra den inbyggda servern i produktion, kommer vi att använda den här för korthetens skull.

php artisan serve --host 0.0.0.0 --port 8000

Nu i en webbläsare, navigera till http://[vultr-instance-ip]:8000. Du kommer att se följande meddelande.

50 Jobs dispatched!

Öppna en ny SSH-anslutning till din server och inuti vår projektrot, kör följande.

php artisan queue:work --once

Detta är den förväntade produktionen:

[2018-02-14 00:03:52] Processing: App\Jobs\FindFavoriteOS
[2018-02-14 00:03:53] Processed:  App\Jobs\FindFavoriteOS

Bekräfta att loggen skapades.

cat storage/logs/laravel.log

Konfigurera Supervisor

För att undvika behovet av att manuellt bearbeta kön kommer vi att använda supervisord. Skapa följande programkonfiguration i /etc/supervisor/conf.d/vultr.conf.

[program:vultr]
process_name=%(program_name)s_%(process_num)02d
command=php [PROJECT_ROOT]/artisan queue:work
autostart=true
autorestart=true
numprocs=8
redirect_stderr=true
stdout_logfile=/var/log/worker.log

Lägg märke till att den rätta sökvägen för att lägga Supervisor-konfigurationsfilen beror på din inställning. Kom också ihåg att ersätta [PROJECT_ROOT]med hela sökvägen till PROJECT_ROOTpå ditt system.

Här konfigurerar vi Supervisor för att automatiskt börja bearbeta kön och, om skriptet går sönder, starta om det. Observera också att vi inte instansierar en enskild arbetare, utan 8 processer. Du är fri att instansiera hur många processer du finner nödvändiga beroende på din applikation.

För att tillåta Supervisor att hantera vår arbetare, tvinga den att läsa om sin konfiguration.

sudo supervisorctl reread
sudo supervisorctl update

Om Arbetsledartjänsten inte har startats behöver ni många starta den.

sudo systemctl start supervisord

Låt oss nu se om jobben bearbetas.

tail -f storage/logs/laravel.log

Navigera till i en webbläsare http://[vultr-instance-ip]:8000. Du kommer att se loggarna som genereras på din konsol.

Slutsats

Vi har framgångsrikt konfigurerat en Laravel-applikation för att använda Beanstalk som en arbetskö. Vi visade också hur man använder Supervisor för att hantera arbetare.