マイクロフレームワークっぽく使う Symfony 4 事始め 5 ~ロギング編~

Symfony 4 入門。前回の記事は以下

Symfonyでのログ出力

Symfonyでのログ出力には基本的には monolog を使います。これはPSR-3に準拠するログ出力ライブラリで、この記事の第1回の時点で自動的に導入されています。また、DIコンテナによる注入にも初期状態で対応しているので、 Psr\Log\LoggerInterface を受け取るコンストラクタや関数を用意すればDIコンテナにより自動的に注入されます。

今回は第3回で作成したサービスクラス BooksService にログ出力を追加してみます。前回までの状態は以下。

<?php
namespace App\Service;

use App\Repository\BooksRepository;

class BooksService
{
    private $booksRepository;

    public function __construct(BooksRepository $booksRepository)
    {
        $this->booksRepository = $booksRepository;
    }

    public function bookDetail(int $book_id)
    {
        return $this->booksRepository->get($book_id);
    }
}

コンストラクタでLoggerInterfaceを受け取るようにします。受け取ったロガーを利用してログを出力します。

<?php
namespace App\Service;

use App\Repository\BooksRepository;

class BooksService
{
    private $booksRepository;

    /** @var Psr\Log\LoggerInterface logger */
    protected $logger;

    public function __construct(BooksRepository $booksRepository, \Psr\Log\LoggerInterface $logger)
    {
        $this->booksRepository = $booksRepository;
        $this->logger = $logger;
    }

    public function bookDetail(int $book_id)
    {
        $this->logger->log('info', 'book_id: ' . $book_id . ' の詳細データを取得して返します');
        return $this->booksRepository->get($book_id);
    }
}

ログを出力する関数には
log(‘ログレベル’, ‘メッセージ’)
の他にそれぞれのログレベルに対応した
emergency(‘メッセージ’)
alert(‘メッセージ’)
critical(‘メッセージ’)
warning(‘メッセージ’)
notice(‘メッセージ’)
info(‘メッセージ’)
debug(‘メッセージ’)
が利用できます。上に有るものが重要度の高いログになっています。

実際にログ出力を埋め込んだ bookDetail が呼びされる http://127.0.0.1:8000/books/detail/2/ にアクセスしてみます。

ログファイルは /var/log/dev.log に出力されています。

このファイル名の dev という部分は環境定義によるものなので、ユニットテスト実行時は test.log 、本番環境で動かす際は prod.log になります。

ログのローテーション

例えばLinux側にもログをローテーションするための仕組みは有り、それを利用してログファイルを管理してもいいですが、逆にプログラム側で最初からファイル名に日付を付けてほしいという場合も有るでしょう。それはmonologの設定で可能です。
config/packages/dev/monolog.yaml
は初期状態で以下のようになっています。

monolog:
    handlers:
        main:
            type: stream
            path: "%kernel.logs_dir%/%kernel.environment%.log"
            level: debug
            channels: ["!event"]
        # uncomment to get logging in your browser
        # you may have to allow bigger header sizes in your Web server configuration
        #firephp:
        #    type: firephp
        #    level: info
        #chromephp:
        #    type: chromephp
        #    level: info
        console:
            type: console
            process_psr_3_messages: false
            channels: ["!event", "!doctrine", "!console"]

typeの部分に指定されている stream がデフォルトの出力方法になっています。これを rotating_file に変更します。この状態でログを出力してみると

dev-2019-02-31.log と日付付きのファイル名で出力されるようになりました。

monologには他にもエラーをSlackに通知したりなどファイル出力に限らないログ出力機能を備えているようです。私自身も試せていませんが重要度の高いエラーは外部の監視に頼らずに通知できたりなども出来そうですね。

次回は本番環境での公開方法について。