Správa pracovních front Laravel pomocí Beanstalk a správce na Ubuntu 16.04

Beanstalk je rychlá a jednoduchá pracovní fronta. Umožňuje asynchronně spouštět časově náročné úlohy, jako je odesílání e-mailů, připojení k externím rozhraním API nebo zpracování obrázků. Tím snížíte latenci své webové aplikace. Laravel poskytuje přímou podporu pro beanstalkd.

V tomto tutoriálu nainstalujeme beanstalkd, nastavíme demo aplikaci Laravel a budeme spravovat pracovníky fronty prostřednictvím správce . Demo aplikace získá seznam dostupných OS z Vultr API a náhodně vybere jeden.

Předpokládá se, že v systému již máte nainstalovaného správce. Pokud tak neučiníte, měli byste si přečíst následující návod, jak nastavit správce: Instalace a konfigurace správce na Ubuntu 16.04

Předpokládá se také, že máte přístup SSH ke své instanci Vultr.

Instalace Beanstalk

Prvním krokem je instalace beanstalkd.

sudo apt-get update
sudo apt-get install beanstalkd

Spusťte službu.

sudo systemctl start beanstalkd

Můžete také povolit spuštění služby po inicializaci systému.

sudo systemctl enable beanstalkd

Zkontrolujte stav služby zadáním následujícího příkazu.

sudo systemctl status beanstalkd

Ve výchozím nastavení beanstalkdnaslouchá na portu 11300. Beanstalk používá jednoduchý textový protokol popsaný ve svém github úložišti . Jeho protokol můžete otestovat spuštěním telnet.

telnet localhost 11300

Napište následující a stiskněte ENTER.

list-tubes

Měli byste vidět seznam zkumavek dostupných na serveru:

OK 14
---
- default

Chcete-li připojení ukončit, jednoduše napište quita stiskněte ENTER.

Trubky v Beanstalk představují pracovní fronty. Beanstalk se skládá v podstatě z výrobců , spotřebitelů , pracovních míst a trubek . Výrobci vkládají zakázky do tuby, která má být spotřebována (zpracována) libovolným počtem spotřebitelů. Všimněte si, že jak výrobci, tak spotřebitelé jsou prostě klienty serveru Beanstalk a jsou na sobě zcela nezávislí. V praxi to znamená, že pomocí Beanstalk můžete vytvářet své zakázky ve své aplikaci PHP a nechat je zpracovávat například v aplikaci NodeJS. Naštěstí Laravel toto vše abstrahuje a poskytuje nám velmi jednoduché API pro odesílání a zpracování úloh, jak uvidíme dále.

Ukázkový projekt

Abychom mohli sestavit náš ukázkový projekt, musíme nejprve nainstalovat jeho závislosti. Chystáme se nainstalovat PHP a Composer.

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

Nyní vytvořte projekt založený na Laravel 5.5.

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

Dále cddo nedávno vytvořené složky. Od této chvíle budeme pracovat v tomto adresáři. Tato složka může být později označena jako PROJECT_ROOT.

cd vultr/

Abychom mohli používat Beanstalk v Laravelu, musíme nainstalovat ještě jednu závislost, klienta PHP Beanstalk.

composer require pda/pheanstalk ~3.0

Musíme také vytvořit zastoupení Job. V Laravelu je to třída uvnitř app/Jobssložky. Laravel má konzolový příkaz, který nám pomůže vytvořit třídu Job. Pojďme vytvořit naši ukázkovou práci.

php artisan make:job FindFavoriteOS

Aktualizujte app/Jobs/FindFavoriteOS.phpsoubor na následující.

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

Metoda handle je to, co bude efektivně provedeno, když je úloha spotřebována. Zde načteme data z Vultr API, náhodně vybereme OS a zapíšeme zvolený OS do souboru protokolu. Soubor protokolu se nachází na adrese storage/logs/laravel.log.

Již jsme nainstalovali Beanstalk a definovali úlohu, kterou má provést. Nyní je čas říct Laravelu, aby použil Beanstalk jako výchozí pracovní frontu. Zkopírujte výchozí .envsoubor poskytnutý instalací Laravel.

cp .env.example .env

Nyní otevřete .envsoubor a aktualizujte řádek, kde je zadán ovladač fronty.

QUEUE_DRIVER=beanstalkd

Nakonec vygenerujte klíč aplikace.

php artisan key:generate

Nyní jsme připraveni odeslat úlohy do pracovní fronty Beanstalk.

Dispečink a chod zakázek

Odeslání zakázky v Laravelu je docela jednoduché. Aktualizujte routes/web.phpsoubor.

<?php

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

    return '50 Jobs dispatched!';
});

Navzdory tomu, že nedoporučujeme spouštět vestavěný poskytnutý server v produkci, zde jej kvůli stručnosti použijeme.

php artisan serve --host 0.0.0.0 --port 8000

Nyní ve webovém prohlížeči přejděte na http://[vultr-instance-ip]:8000. Uvidíte následující zprávu.

50 Jobs dispatched!

Otevřete nové připojení SSH k vašemu serveru a v kořenovém adresáři našeho projektu proveďte následující.

php artisan queue:work --once

Toto je očekávaný výstup:

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

Potvrďte, že byl protokol vygenerován.

cat storage/logs/laravel.log

Konfigurace správce

Abychom se vyhnuli nutnosti ručního zpracování fronty, použijeme supervisord. Vytvořte následující konfiguraci programu v /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

Všimněte si, že správná cesta k umístění konfiguračního souboru správce bude záviset na vašem nastavení. Nezapomeňte také nahradit [PROJECT_ROOT]úplnou cestu k souboru PROJECT_ROOTve vašem systému.

Zde konfigurujeme správce, aby automaticky zahájil zpracování fronty a v případě přerušení skriptu ji restartoval. Všimněte si také, že nevytváříme instanci jednoho pracovníka, ale 8 procesů. Bez ohledu na to, kolik procesů považujete za nezbytné v závislosti na vaší aplikaci, můžete vytvářet instance.

Chcete-li nadřízenému umožnit správu našeho pracovníka, přinuťte jej, aby znovu načetl svou konfiguraci.

sudo supervisorctl reread
sudo supervisorctl update

Pokud služba Supervisor nebyla spuštěna, je nutné ji spustit.

sudo systemctl start supervisord

Nyní se podívejme, zda se úlohy zpracovávají.

tail -f storage/logs/laravel.log

Ve webovém prohlížeči přejděte na http://[vultr-instance-ip]:8000. Uvidíte generování protokolů na vaší konzoli.

Závěr

Úspěšně jsme nakonfigurovali aplikaci Laravel tak, aby používala Beanstalk jako pracovní frontu. Také jsme si ukázali, jak používat správce k řízení pracovníků.