라라벨 Horizon

시작하기

Horizon은 Redis Queue를 사용하는 라라벨을 위해서 아름다운 대시보드 와 코드를 기반으로한 설정기능을 제공합니다. Horizon을 사용하면 job의 처리량, 실행시간 및 실패한 job과 같은 Queue 시스템의 주요 메트릭을 손쉽게 모니터링 할 수 있습니다.

모든 worker의 설정은 하나의 간단한 설정 파일에 저장되기 때문에, 팀원 모두와 협업 할 수 있도록 소스 컨트롤에 보관 할 수 있습니다.

설치하기

{note} Horizon은 비동기 프로세스 시그널을 사용 하므로 PHP 7.1이상이 필요합니다.

컴포저-Composer를 사용하여 라라벨 프로젝트에 Horizon을 설치 합니다:

composer require laravel/horizon

Horizon을 설치 한 뒤에 vendor:publish 아티즌 명령어를 이용하여 에셋(assets) 파일을 퍼블리싱 합니다:

php artisan vendor:publish --provider="Laravel\Horizon\HorizonServiceProvider"

설정하기

퍼블리싱을 완료하고 나면 config/horizon.php라는 주요 설정파일이 복사됩니다. 이 파일을 통해서 worker의 옵션을 설정 할 수 있습니다. 각각 설정 옵션에는 용도에 대한 설명이 주석으로 표시 되어있으므로 내용을 자세히 확인 하시기 바랍니다.

밸런스 옵션

Horizon은 simple, auto, false 세가지 밸런싱 방법을 선택 할 수 있습니다. 기본 값인 simple은 요청되는 job을 프로세스간에 균등하게 나눕니다:

'balance' => 'simple',

auto는 queue의 현재 작업 부하량을 기준으로 queue당 worker 프로세스를 조절 합니다. 예를들어 notifications queue에 1000개의 작업이 대기중인데, render queue는 비어있는 경우라면, Horizon은 notifications queue가 비게 될때까지 더 많은 worker를 notification queue에 배정 합니다. 밸런스 옵션이 false일 경우에는, 라라벨 기본 동작으로 설정에 나열된 순서 대로 queue를 처리합니다.

Dashboard 인증

Horizon Dashboard는 /horizon으로 접속 가능하며, 기본적으로 local 환경에서만 접근이 가능합니다. Dashboard에 대해 보다 더 구체적인 액세스 정책을 정의 하려면 Horizon::auth 메서드를 사용하면 됩니다. auth 메서드는 사용자가 Horizon Dashboard에 액세스 할 수 있는지 여부를 나타내는 true 또는 false을 리턴하는 callback을 인자로 받습니다. 일반적으로 Horizon::authAppServiceProviderboot메서드 안에서 호출 해야 합니다

Horizon::auth(function ($request) {
    // return true / false;
});

Horizon 실행하기

config/horizon.php 파일에서 worker의 설정을 구성한 뒤에 horizon 아티즌 명령어를 사용하여 horizon를 시작 할 수 있습니다. 이 하나의 명령어를 실행하면 모든 worker들이 시작됩니다:

php artisan horizon

horizon:pausehorizon:continue 아티즌 명령어를 사용하여 Horizon 프로세스를 일시 정지하고 계속 진행 시킬 수 있습니다:

php artisan horizon:pause

php artisan horizon:continue

horizon:terminate 아티즌 명령어를 사용하여 마스터 Horizon 프로세스를 안전하게(gracefully) 종료 할 수 있습니다. 이렇게 하면 Horizon이 현재 처리 중인 모든 작업이 완료되나서 프로세스가 종료됩니다:

php artisan horizon:terminate

Horizon 배포하기

라이브서버에 Horizon을 배포하는 경우 php artisan horizon 커맨드가 계속 실행되는지 프로세스 모니터를 구성하여 예기치 않게 종료되면 다시 시작해야합니다. 서버에 새로운 코드를 배포하는 경우 변경된 새로운 코드를 받은 뒤에, 프로세스 모니터가 다시 프로세스를 실행 할 수 있도록 메인 Horizon 프로세스를 종료해야합니다.

Supervisor 설정하기

horizon 프로세스를 감시하는 프로세스 모니터로 Supervisor를 사용 하려는 경우, 아래의 설정 파일을 사용하면 충분합니다:

[program:horizon]
process_name=%(program_name)s
command=php /home/forge/app.com/artisan horizon
autostart=true
autorestart=true
user=forge
redirect_stderr=true
stdout_logfile=/home/forge/app.com/horizon.log

{tip} 직접 서버를 관리하는게 힘들다면, 라라벨 Forge 사용을 고려 해보십시오. Forge는 Horizon을 통해 모던하고 강력한 라라벨 애플리케이션을 실행하는 데 필요한 모든 기능을 갖춘 PHP7+ 서버를 제공합니다.

태그

Horizon을 사용하면 mailables, event broadcasts, notifications 및 queued event listeners 작업에 "태그"를 할당할 수 있습니다. 실제로 Horizon은 job에 연결된 Eloguent 모델에 따라 대부분의 job을 지능적이고 자동으로 태그 처리합니다. 예를 들어 아래의 작업을 살펴 봅시다:

<?php

namespace App\Jobs;

use App\Video;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;

class RenderVideo implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    /**
     * The video instance.
     *
     * @var \App\Video
     */
    public $video;

    /**
     * Create a new job instance.
     *
     * @param  \App\Video  $video
     * @return void
     */
    public function __construct(Video $video)
    {
        $this->video = $video;
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        //
    }
}

id1App\Video인스턴스가 queue에 있는 job에 있는 경우 자동으로 App\Video:1 태그를 할당 받게됩니다. Horizon은 모든 Eloquent 모델의 job 속성을 확인하기 때문입니다. Eloquent 모델이 발견되면 Horizon은 모델의 클래스 이름과 기본 키를 사용하여 job에 알아서 태그를 지정합니다:

$video = App\Video::find(1);

App\Jobs\RenderVideo::dispatch($video);

수동으로 태그 지정하기

queueable objects에 수동으로 태그를 정하고 싶은 경우 클래스의 tags 메서드를 정의 하면 됩니다:

class RenderVideo implements ShouldQueue
{
    /**
     * Get the tags that should be assigned to the job.
     *
     * @return array
     */
    public function tags()
    {
        return ['render', 'video:'.$this->video->id];
    }
}

알림

Note: 알림을 사용하기 전에 프로젝트에 guzzlehttp/guzzle 컴포저(composer) 패키지를 등록 해야 합니다. SMS 알림을 보내도록 Horizon을 설정 하는 경우 이 링크를 참고하시기 바랍니다 Nexmo 알림 드라이버 사전 준비사항.

대기 시간이 긴 Queue에 대한 알림을 받으려면 애플리케이션의 AppServiceProvider에서 Horizon::routeMailNotificationsTo, Horizon::routeSlackNotificationsTo, 또는 Horizon::routeSmsNotificationsTo 메서드를 사용 하십시오:

Horizon::routeMailNotificationsTo('example@example.com');
Horizon::routeSlackNotificationsTo('slack-webhook-url', '#channel');
Horizon::routeSmsNotificationsTo('15556667777');

알림 대기 시간의 임계값 설정하기

config/horizon.php 설정 파일에 "긴 대기시간"으로 간주하는 기준 시간을 설정 할 수 있습니다. 파일 내의 waits 설정 옵션에서 각 연결/queue 조합에 대한 긴 대기 임계값을 제어 할 수 있습니다 :

'waits' => [
    'redis:default' => 60,
],

메트릭

Horizon에는 job 및 queue의 대기 시간과 처리량에 대한 정보를 제공하는 메트릭 dashboard가 포함되어 있습니다. 이 dashboard에 정보를 제공하려면 애플리케이션의 scheduler를 통해 Horizon의 snapshot 아티즌 커맨드를 5분마다 실행 하도록 설정해야 합니다:

/**
 * Define the application's command schedule.
 *
 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
 * @return void
 */
protected function schedule(Schedule $schedule)
{
    $schedule->command('horizon:snapshot')->everyFiveMinutes();
}