Håndtering af Laravel-arbejdskøer med Beanstalk og Supervisor på Ubuntu 16.04

Beanstalk er en hurtig og enkel arbejdskø. Det giver dig mulighed for at køre tidskrævende opgaver asynkront, såsom at sende e-mails, oprette forbindelse til eksterne API'er eller behandle billeder. Ved at gøre det reducerer du din webapp-forsinkelse. Laravel giver out-of-the-box support til beanstalkd.

I denne vejledning vil vi installere beanstalkd, opsætte en demo Laravel-applikation og administrere køarbejderne gennem Supervisor . Demoapplikationen vil få en liste over tilgængelige OS'er fra Vultr API og tilfældigt vælge en.

Det antages, at du allerede har Supervisor installeret på dit system. Hvis du ikke gør det, bør du læse følgende vejledning om, hvordan du opsætter Supervisor: Installation og konfiguration af Supervisor på Ubuntu 16.04

Det antages også, at du har SSH-adgang til din Vultr-instans.

Installation af Beanstalk

Det første skridt at tage er at installere beanstalkd.

sudo apt-get update
sudo apt-get install beanstalkd

Start tjenesten.

sudo systemctl start beanstalkd

Du kan også aktivere tjenesten til at starte ved systeminitialisering.

sudo systemctl enable beanstalkd

Tjek servicestatus ved at udstede følgende kommando.

sudo systemctl status beanstalkd

Lytter som standard beanstalkdpå porten 11300. Beanstalk bruger en simpel tekstbaseret protokol beskrevet i dets github-lager . Du kan teste dens protokol ved at køre telnet.

telnet localhost 11300

Skriv følgende og tryk på ENTER.

list-tubes

Du bør se en liste over tilgængelige rør på serveren:

OK 14
---
- default

For at lukke forbindelsen skal du blot skrive quitog derefter trykke på ENTER.

Rør i Beanstalk repræsenterer arbejdskøer. Bønnestilk består grundlæggende af producenter , forbrugere , jobs og rør . Producenterne lægger job i et rør for at blive forbrugt (bearbejdet) af et vilkårligt antal forbrugere. Bemærk, at både producenter og forbrugere simpelthen er klienter af Beanstalk-serveren og er fuldstændig uafhængige af hinanden. Rent praktisk betyder det, at du ved at bruge Beanstalk kan producere dine jobs i din PHP-applikation og få dem behandlet i en NodeJS-app for eksempel. Heldigvis abstraherer Laravel alt dette og giver os en meget enkel API til at sende og håndtere job, som vi vil se næste gang.

Eksempel på projekt

For at bygge vores eksempelprojekt skal vi først installere dets afhængigheder. Vi skal installere PHP og Composer.

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

Opret nu projektet baseret på Laravel 5.5.

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

Næste cdi den nyligt oprettede mappe. Vi vil arbejde i denne mappe fra nu af. Denne mappe kan senere henvises til som PROJECT_ROOT.

cd vultr/

For at bruge Beanstalk i Laravel skal vi installere endnu en afhængighed, PHP Beanstalk-klienten.

composer require pda/pheanstalk ~3.0

Vi skal også oprette en jobrepræsentation. I Laravel er dette en klasse inde i app/Jobsmappen. Laravel har en konsolkommando til at hjælpe os med at oprette en jobklasse. Lad os skabe vores eksempeljob.

php artisan make:job FindFavoriteOS

Opdater 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åndteringsmetoden er det, der effektivt vil blive udført, når jobbet er opbrugt. Her henter vi data fra Vultr API, vælger tilfældigt et OS og skriver det valgte OS til logfilen. Logfilen er placeret på storage/logs/laravel.log.

Vi har allerede installeret Beanstalk og defineret det job, der skal udføres af det. Nu er det tid til at fortælle Laravel at bruge Beanstalk som standard arbejdskø. Kopier standardfilen .envfra Laravel-installationen.

cp .env.example .env

Åbn nu .envfilen og opdater linjen, hvor kødriveren er angivet.

QUEUE_DRIVER=beanstalkd

Til sidst skal du generere en applikationsnøgle.

php artisan key:generate

Vi er nu klar til at sende jobs til Beanstalk-arbejdskøen.

Ekspediering og afvikling af jobs

At sende et job i Laravel er ret simpelt. Opdater routes/web.phpfilen.

<?php

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

    return '50 Jobs dispatched!';
});

Selvom det ikke anbefales at køre den indbyggede server i produktionen, vil vi bruge den her for korthedens skyld.

php artisan serve --host 0.0.0.0 --port 8000

Naviger nu til i en webbrowser http://[vultr-instance-ip]:8000. Du vil se følgende besked.

50 Jobs dispatched!

Åbn en ny SSH-forbindelse til din server og inde i vores projektrod, udfør følgende.

php artisan queue:work --once

Dette er det forventede output:

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

Bekræft, at loggen blev genereret.

cat storage/logs/laravel.log

Konfiguration af Supervisor

For at undgå behovet for manuelt at behandle køen, vil vi bruge supervisord. Opret følgende 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

Bemærk, at den rigtige vej til at placere Supervisor-konfigurationsfilen afhænger af din opsætning. Husk også at erstatte [PROJECT_ROOT]med den fulde sti til PROJECT_ROOTpå dit system.

Her konfigurerer vi Supervisor til automatisk at begynde at behandle køen og, i tilfælde af at scriptet går i stykker, genstarte det. Bemærk også, at vi ikke instansierer en enkelt arbejder, men 8 processer. Du er fri til at instansiere, hvor mange processer du finder nødvendige afhængigt af din applikation.

For at tillade Supervisor at administrere vores medarbejder, tving den til at genlæse sin konfiguration.

sudo supervisorctl reread
sudo supervisorctl update

Hvis Supervisor-tjenesten ikke er startet, er I mange nødt til at starte den.

sudo systemctl start supervisord

Lad os nu se, om opgaverne bliver behandlet.

tail -f storage/logs/laravel.log

Naviger til i en webbrowser http://[vultr-instance-ip]:8000. Du vil se logfilerne blive genereret på din konsol.

Konklusion

Vi har konfigureret en Laravel-applikation til at bruge Beanstalk som en arbejdskø. Vi demonstrerede også, hvordan man bruger Supervisor til at styre medarbejdere.