Administrere Laravel-arbeidskøer med Beanstalk og Supervisor på Ubuntu 16.04

Beanstalk er en rask og enkel arbeidskø. Den lar deg kjøre tidkrevende oppgaver asynkront, som å sende e-post, koble til eksterne APIer eller behandle bilder. Ved å gjøre det vil du redusere ventetiden for nettappen din. Laravel gir direkte støtte for beanstalkd.

I denne opplæringen vil vi installere beanstalkd, sette opp en demo Laravel-applikasjon og administrere køarbeiderne gjennom Supervisor . Demoapplikasjonen vil få en liste over tilgjengelige operativsystemer fra Vultr API og tilfeldig velge ett.

Det antas at du allerede har Supervisor installert på systemet ditt. Hvis du ikke gjør det, bør du lese følgende veiledning om hvordan du setter opp Supervisor: Installere og konfigurere Supervisor på Ubuntu 16.04

Det antas også at du har SSH-tilgang til din Vultr-instans.

Installere Beanstalk

Det første trinnet å ta er å installere beanstalkd.

sudo apt-get update
sudo apt-get install beanstalkd

Start tjenesten.

sudo systemctl start beanstalkd

Du kan også aktivere tjenesten for å starte ved systeminitialisering.

sudo systemctl enable beanstalkd

Sjekk tjenestestatusen ved å gi følgende kommando.

sudo systemctl status beanstalkd

Som standard, beanstalkdlytter på porten 11300. Beanstalk bruker en enkel tekstbasert protokoll beskrevet i dets github-lager . Du kan teste protokollen ved å kjøre telnet.

telnet localhost 11300

Skriv følgende og trykk ENTER.

list-tubes

Du bør se en liste over tilgjengelige rør på serveren:

OK 14
---
- default

For å lukke tilkoblingen, skriv ganske enkelt quitog trykk deretter ENTER.

Rør i Beanstalk representerer arbeidskøer. Bønnestengel er hovedsakelig sammensatt av produsenter , forbrukere , jobber og rør . Produsenter legger jobber i et rør for å bli konsumert (bearbeidet) av et hvilket som helst antall forbrukere. Merk at både produsenter og forbrukere ganske enkelt er klienter av Beanstalk-serveren og er helt uavhengige av hverandre. Rent praktisk betyr dette at du ved å bruke Beanstalk kan produsere jobbene dine i PHP-applikasjonen din og få den behandlet i for eksempel en NodeJS-app. Heldigvis abstraherer Laravel alt dette og gir oss et veldig enkelt API for å sende og håndtere jobber, som vi vil se neste gang.

Eksempel på prosjekt

For å bygge vårt eksempelprosjekt, må vi først installere avhengighetene. Vi skal installere PHP og Composer.

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

Lag nå prosjektet basert på Laravel 5.5.

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

Neste cdinn i den nylig opprettede mappen. Vi vil jobbe i denne katalogen fra nå av. Denne mappen kan bli referert til senere som PROJECT_ROOT.

cd vultr/

For å bruke Beanstalk i Laravel må vi installere en avhengighet til, PHP Beanstalk-klienten.

composer require pda/pheanstalk ~3.0

Vi må også opprette en jobbrepresentasjon. I Laravel er dette en klasse inne i app/Jobsmappen. Laravel har en konsollkommando for å hjelpe oss med å lage en jobbklasse. La oss lage prøvejobben vår.

php artisan make:job FindFavoriteOS

Oppdater app/Jobs/FindFavoriteOS.phpfilen til følgende.

<?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']);
    }
}

Håndtaksmetoden er det som effektivt vil bli utført når jobben er oppbrukt. Her henter vi data fra Vultr API, velger tilfeldig et OS og skriver det valgte OS til loggfilen. Loggfilen ligger på storage/logs/laravel.log.

Vi har allerede installert Beanstalk og definert jobben som skal utføres av den. Nå er det på tide å fortelle Laravel å bruke Beanstalk som standard arbeidskø. Kopier standardfilen .envfra Laravel-installasjonen.

cp .env.example .env

Åpne nå .envfilen og oppdater linjen der kødriveren er spesifisert.

QUEUE_DRIVER=beanstalkd

Til slutt, generer en applikasjonsnøkkel.

php artisan key:generate

Vi er nå klare til å sende jobber til Beanstalk-arbeidskøen.

Ekspedering og kjøring av jobber

Å sende en jobb i Laravel er ganske enkelt. Oppdater routes/web.phpfilen.

<?php

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

    return '50 Jobs dispatched!';
});

Til tross for at det ikke er anbefalt å kjøre den innebygde serveren i produksjon, vil vi bruke den her for korthets skyld.

php artisan serve --host 0.0.0.0 --port 8000

Nå i en nettleser, naviger til http://[vultr-instance-ip]:8000. Du vil se følgende melding.

50 Jobs dispatched!

Åpne en ny SSH-tilkobling til serveren din og inn i prosjektroten vår, utfør følgende.

php artisan queue:work --once

Dette er forventet utgang:

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

Bekreft at loggen ble generert.

cat storage/logs/laravel.log

Konfigurere Supervisor

For å unngå behovet for å behandle køen manuelt, vil vi bruke supervisord. Opprett følgende programkonfigurasjon 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

Legg merke til at den riktige banen for å sette Supervisor-konfigurasjonsfilen vil avhenge av oppsettet ditt. Husk også å erstatte [PROJECT_ROOT]med hele banen til PROJECT_ROOTpå systemet ditt.

Her konfigurerer vi Supervisor til å automatisk begynne å behandle køen og, i tilfelle skriptet går i stykker, å starte det på nytt. Vær også oppmerksom på at vi ikke instansierer en enkelt arbeider, men 8 prosesser. Du står fritt til å instansiere hvor mange prosesser du finner nødvendige avhengig av søknaden din.

For å la Supervisor administrere arbeideren vår, tving den til å lese konfigurasjonen på nytt.

sudo supervisorctl reread
sudo supervisorctl update

Hvis Veiledertjenesten ikke er startet, må dere mange starte den.

sudo systemctl start supervisord

La oss nå se om jobbene blir behandlet.

tail -f storage/logs/laravel.log

Naviger til i en nettleser http://[vultr-instance-ip]:8000. Du vil se loggene som genereres på konsollen din.

Konklusjon

Vi har konfigurert en Laravel-applikasjon til å bruke Beanstalk som en arbeidskø. Vi demonstrerte også hvordan man bruker Supervisor til å administrere arbeidere.