Керування чергами роботи 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 ви можете створювати свої завдання у своїй програмі 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']);
    }
}

Метод ручки – це те, що буде ефективно виконуватися, коли робота буде використана. Тут ми отримуємо дані з API Vultr, випадковим чином вибираємо ОС і записуємо вибрану ОС у файл журналу. Файл журналу знаходиться за адресою 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 для керування працівниками.