LaravelでQueueのジョブ完了イベントを使ってログ履歴を残す

LaravelでQueueのジョブ完了イベントを使ってログ履歴を残す

記事一覧LaravelでQueueのジョブ完了イベントを使ってログ履歴を残す

Laravel の Queue のリスナーは便利なのですが、ジョブの失敗は failed_jobs テーブルなどに残せるものの、逆にジョブの実行に成功した場合の履歴が残しにくい作りになっています。

ただ、一応、ジョブ実行成功時の機構は用意されていて、ServiceProvider クラスでコールバックを受け取ることができます。

実際に職場で実装してみて問題なく使えたので、他のバージョンを含めて振り返ってみます。

実際に Laravel はバージョン 5.1 が LTS(Long Term Support)で、次の LTS が 5.5 なので、5.2~5.4 については触れなくてもいいかもしれませんが・・・。

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Queue::after(function($connection, $job, $data) {
            //
        });
    }

boot メソッドの中に Queue::after() にコールバック関数が定義できるので、ここでログ出力することでジョブの成功を履歴に残すことができます。

Laravel5.2 からは引数が「JobProcessed $event」だけになっているので、5.1 のこれは使い勝手が悪かったのでしょうか。

ジョブ完了イベント - Laravel5.1

ジョブ名の取得

まず、どのジョブが実行されたのかを確認するには、3 番目の引数の $data から該当のジョブクラスを特定します。

ジョブのクラス名だけであれば、強引に以下で取得できなくもないですが、$job 変数からあっさり取れるってこともあるかも。

$command = unserialize($data['data']['command']);
$class_name = get_class($command);
$job_name = str_replace('App\\Jobs\\', '', $class_name);

っと思ってみたのですが、$job のオブジェクトにはそのような振る舞いは実装されていないので、$command からジョブのクラスで用意した実装を活かすのが良さそうです。

例えば、各ジョブのクラスに必要な情報が取得できるような public なメソッドを実装しておけば、上記 $command 変数から参照が可能になります。

これを利用して履歴として残しておきたい情報を受け取るのも 1 つの方法かなと思います。

// 該当のジョブクラスから必要な情報を受け取る
$log = $command->getHoge();
echo $log['id'] . PHP_EOL;
echo $log['name'] . PHP_EOL;
// ジョブクラスには必要な情報を渡すメソッドを実装しておく
class HogeJob extends Job implements ... {

    private $log;

    (省略)

    public function handle() {

        (省略)

        // 処理の最後に必要な情報を設定
        $this->log['id'] = $id;
        $this->log['name'] = $name;
    }

    public function getHoge() {
        return $this->log;
    }

参考カテゴリ

オススメ記事

最新の投稿やよく見られているのオススメ記事一覧です。

標準出力と標準エラー出力をパイプに渡す

よく、標準出力先をファイルにリダイレクトすることはありますが、意外に標準エラー出力は使う機会がありません。しかし、やはりツールやパッケージ製品になると標準エラー出力も活用されているようです。でも、...

Linux(FreeBSD)

>>記事を確認する

主要無料ブログ5つに対する自動投稿PHPプログラム

アメブロへ楽天APIなどの情報を自動で投稿する の反響が良かったので、どうせならアメブロ以外の無料ブログの XML-RPC を使った自動投稿も紹介したいと思います。これには FC2BlogManager.php というライブ...

PHP

>>記事を確認する

snmpでデバイスの情報を取得

snmpでデバイスの情報を取得するコマンドです。これを元に、ディスクIOなどのMIB値を探します。 $ snmpwalk -v 2c -c {SNMPGROUPNAME} localhost 1.3.6.1.4.1.2021.13.15.1.1.2 (結果の一部) UCD-DIS...

Linux(FreeBSD)

>>記事を確認する

awkで指定したカラム以降をprint表示する

前回、awk で最後のカラム以外を表示してみましたが、今回は指定したカラム以降のカラムを全部表示したいと思います。 例えば、7 個の文字列がカンマで区切られているファイルがあるとしたら、3 番目のカラム...

awk / シェル

>>記事を確認する

CentOSでRedisサーバを使う

冗長化した Web サーバなどで、セッションの管理や、セッションや特定のユーザーに紐付く一時データを管理するのに memcache を使う場面は多いと思います。 その memcache の中でも主流なのが memcached です...

Linux(FreeBSD) / CentOS / Redis

>>記事を確認する

ドメイン取るなら低価格で楽々管理

バリュードメインは、GMO デジロック社の低価格ドメイン総合サービスです。

このサイト含め、私もこれまでに 100 個以上のドメインを取得して管理してきましたが、WHOIS の代理公開も可能なので、無料 SSL 証明書の Let's Encrypt と組み合わせれば、かなりの低価格で SSL サイトも運営できます。

年単位で領収証発行もしてくれるので、たくさんサイトを抱えているアフィリエイターや個人事業主にもオススメです。

AWSの無料利用枠内で複数サイトをサクサクと運営する方法

MySQLでテーブル定義を取得

似たような構成のテーブルを作る時に、今までは mysqldump コマンドで -d オプションを付けて実行していました。 これでも十分に要件は満たせるのですが、MySQL のコンソールからサクっと出したい場合もある...

データベース / MySQL

>>記事を確認する

Poderosa5の登場と文字色と背景色

新しい PC を購入したので、久し振りに Poderosa のインストールをしたのですが、Poderosa-Terminal として最新バージョンの 5 が 2016 年に登場していました。 これ、職場でもインストールしてみたのですが...

Windows / ツール

>>記事を確認する

Laravel5.1からLaravel5.5へアップデートする

LTS だった Laravel5.1 のバグフィックスサポートが 2017 年の 6 月で終わり、セキュリティサポートも 2018 年の 6 月で終了となります。 このタイミングで、兼ねてから発表のあった、次期 LTS の Laravel5.5...

PHP / PHPフレームワーク / Laravel

>>記事を確認する

VagrantでCentOS6.9のイメージを使う

CentOS7 が既に 7.3 まで出ていますが、AmazonLinux がまだ 6 の構成と似ていることから、なかなか 7 系に移行できません。 そこで、Vagrant のイメージも 6 系の最新版を使うと思ったのですが、下記の BOX ...

Linux(FreeBSD) / CentOS / Vagrant

>>記事を確認する