Управление на работните опашки на Laravel с Beanstalk и Supervisor в Ubuntu 16.04

Beanstalk е бърза и проста работна опашка. Позволява ви да изпълнявате отнемащи време задачи асинхронно, като изпращане на имейли, свързване с външни API или обработка на изображения. По този начин ще намалите забавянето на вашето уеб приложение. Laravel осигурява готова поддръжка за beanstalkd.

В този урок ще инсталираме beanstalkd, настроим демонстрационно приложение Laravel и ще управляваме работниците на опашката чрез Supervisor . Демо приложението ще получи списък с наличните операционни системи от Vultr API и произволно ще избере една.

Предполага се, че вече имате инсталиран Supervisor във вашата система. Ако не го направите, трябва да прочетете следния урок за това как да настроите Supervisor: Инсталиране и конфигуриране на Supervisor в Ubuntu 16.04

Предполага се също, че имате SSH достъп до вашия Vultr екземпляр.

Инсталиране на Beanstalk

Първата стъпка, която трябва да направите, е да инсталирате beanstalkd.

sudo apt-get update
sudo apt-get install beanstalkd

Стартирайте услугата.

sudo systemctl start beanstalkd

Можете също да разрешите стартирането на услугата при инициализиране на системата.

sudo systemctl enable beanstalkd

Проверете състоянието на услугата, като издадете следната команда.

sudo systemctl status beanstalkd

По подразбиране beanstalkdслуша на порта 11300. Beanstalk използва прост, базиран на текст протокол, описан в неговото хранилище на github . Можете да тествате протокола му, като стартирате telnet.

telnet localhost 11300

Напишете следното и натиснете ENTER.

list-tubes

Трябва да видите списък с тръби, налични на сървъра:

OK 14
---
- default

За да затворите връзката, просто въведете quitи след това натиснете ENTER.

Тръбите в Beanstalk представляват работни опашки. Beanstalk се състои основно от производители , потребители , работни места и тръби . Производителите поставят работни места в епруветка, за да бъдат консумирани (обработени) от произволен брой потребители. Имайте предвид, че както производителите, така и потребителите са просто клиенти на сървъра Beanstalk и са напълно независими един от друг. На практика това означава, че с помощта на Beanstalk можете да създавате вашите работни места във вашето PHP приложение и да ги обработвате в приложение на NodeJS например. За щастие, Laravel абстрахира всичко това и ни предоставя много прост API за изпращане и обработка на задачи, както ще видим по-нататък.

Примерен проект

За да изградим нашия примерен проект, първо трябва да инсталираме неговите зависимости. Ще инсталираме PHP и Composer.

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

Сега създайте проекта на базата на Laravel 5.5.

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

След това cdв наскоро създадената папка. От сега нататък ще работим в тази директория. Тази папка може да бъде посочена по-късно като PROJECT_ROOT.

cd vultr/

За да използваме Beanstalk в Laravel, трябва да инсталираме още една зависимост, PHP Beanstalk клиента.

composer require pda/pheanstalk ~3.0

Също така трябва да създадем представителство за работа. В Laravel това е клас в app/Jobsпапката. Laravel има конзолна команда, която да ни помогне да създадем клас Job. Нека създадем нашата примерна работа.

php artisan make:job FindFavoriteOS

Актуализирайте app/Jobs/FindFavoriteOS.phpфайла до следното.

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

Методът на манипулиране е това, което ще бъде ефективно изпълнено, когато задачата се консумира. Тук извличаме данни от Vultr API, избираме произволно ОС и записваме избраната ОС в регистрационния файл. Регистрационният файл се намира на адрес storage/logs/laravel.log.

Вече сме инсталирали Beanstalk и дефинирахме заданието, което да бъде изпълнено от него. Сега е време да кажете на Laravel да използва Beanstalk като работна опашка по подразбиране. Копирайте .envфайла по подразбиране, предоставен от инсталацията на Laravel.

cp .env.example .env

Сега отворете .envфайла и актуализирайте реда, където е посочен драйверът на опашката.

QUEUE_DRIVER=beanstalkd

Накрая генерирайте ключ за приложение.

php artisan key:generate

Вече сме готови да изпращаме задания към работната опашка на Beanstalk.

Диспечериране и изпълнение на задачи

Изпращането на работа в Laravel е доста просто. Актуализирайте routes/web.phpфайла.

<?php

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

    return '50 Jobs dispatched!';
});

Въпреки че не се препоръчва да стартирате вградения предоставен сървър в производството, ние ще го използваме тук за краткост.

php artisan serve --host 0.0.0.0 --port 8000

Сега в уеб браузър отидете до http://[vultr-instance-ip]:8000. Ще видите следното съобщение.

50 Jobs dispatched!

Отворете нова SSH връзка към вашия сървър и в корена на нашия проект изпълнете следното.

php artisan queue:work --once

Това е очакваният изход:

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

Потвърдете, че дневникът е генериран.

cat storage/logs/laravel.log

Конфигуриране на Supervisor

За да избегнем необходимостта от ръчна обработка на опашката, ще използваме supervisord. Създайте следната конфигурация на програмата в /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

Обърнете внимание, че правилният път за поставяне на конфигурационния файл на Supervisor ще зависи от вашата настройка. Също така, не забравяйте да замените [PROJECT_ROOT]с пълния път към PROJECT_ROOTвашата система.

Тук конфигурираме Supervisor да започне автоматично да обработва опашката и, в случай на счупване на скрипта, да го рестартира. Също така имайте предвид, че ние не инстанцираме един работник, а 8 процеса. Вие сте свободни да инстанцирате колкото и много процеси, които сметнете за необходими, в зависимост от вашето приложение.

За да позволите на Supervisor да управлява нашия работник, принудете го да препрочете конфигурацията си.

sudo supervisorctl reread
sudo supervisorctl update

Ако услугата Supervisor не е стартирана, много трябва да я стартирате.

sudo systemctl start supervisord

Сега нека видим дали заданията се обработват.

tail -f storage/logs/laravel.log

В уеб браузър отидете до http://[vultr-instance-ip]:8000. Ще видите регистрационните файлове, които се генерират на вашата конзола.

Заключение

Успешно конфигурирахме приложение Laravel да използва Beanstalk като работна опашка. Също така, ние демонстрирахме как да използваме Supervisor за управление на работниците.