Log on ララジャパン

メールをログに出力する

Wed, 24 Jan 2024 07:40:40 +0900

ローカル環境におけるメール送信部分を確認する際に以前の記事でMailtrapやMailhogを活用した方法を紹介していますが、もっと原始的且つ手っ取り早い方法としてLogに出力して確認するというオプションもあります。今回はそちらの方法をご紹介致します。

メールをログに出力する

メールをログに出力するにはメーラーにlogを指定するだけです。特定の場面においてlog出力に切り替えたいなら以下のようにmailer()を使って指定できます。過去の記事で紹介されたraw()を使えばMailableクラスを作成せずに簡単にテスト用のメールが送信できますよ。

Mail::mailer('log')->raw('This ia a test mail.', fn($m) => $m->subject('Test mail')->to('test@example.com'));

するとデフォルトの設定では、storage/logs/laravel.logに出力されるはずです。

storage/logs/laravel.log

[2024-01-21 02:23:12] local.DEBUG: From: Example <hello@example.com>
Subject: Test mail
To: test@example.com
MIME-Version: 1.0
Date: Sun, 21 Jan 2024 02:23:12 +0000
Message-ID: <2c6e264f57ffa38f94b5bee86bdb1493@example.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

This ia a test mail.

デフォルトのメーラーをlogに切り替えたい場合は.envのMAIL_MAILERにlogを指定すればOKです。

.env

...
#MAIL_MAILER=smtp    // デフォルトではsmtpが設定されていますね
MAIL_MAILER=log
...

そうすれば、mailer()で指定せずともlogメーラーが採用されます。

Mail::raw('This ia a test mail.', fn($m) => $m->subject('Test mail')->to('test@example.com'));

設定を理解する

何がどうしてlaravel.logに出力されたのか解説します。まず、MAIL_MAILERにlogを指定した場合、config/mail.phpにて以下の設定が使用されます。

config/mail.php

...
'mailers' => [
...
        'log' => [
            'transport' => 'log',
            'channel' => env('MAIL_LOG_CHANNEL'),
        ],
...

出力先のログチャンネルを.envのMAIL_LOG_CHANNELから取得していますね。しかし、先ほどの実行時にはMAIL_LOG_CHANNELを定義していません。故にこちらの値はnullとなります。チャンネルの指定が無い場合、ログ出力においてはdefaultのチャンネルが採用されます。config/logging.phpを見てみましょう。

config/logging.php

...
'default' => env('LOG_CHANNEL', 'stack'),    // ←①
...
    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],    // ←②
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),    // ←③
            'level' => env('LOG_LEVEL', 'debug'),
            'replace_placeholders' => true,
        ],
...

①defaultのチャンネルはstackです。②stackチャンネルではstackドライバが指定されており、ログの出力先を複数指定したい場合にそれらをバインドして指定できます。デフォルトの設定ではsingleチャンネルのみが指定されていました。そして、③このsingleチャンネルの出力先がlaravel.logと言うわけです。文章にするとやや複雑に感じますが、実際にconfigを辿るとそれほどでもありません。

出力先ログチャンネルを変更する

logメーラーを使用した際の出力先ログチャンネルを変更したい場合は、.envにおいてMAIL_LOG_CHANNELを指定すればOKです。試しにmail_debugログチャンネルを新たに作成し、そちらに出力してみましょう。まずは、config/logging.phpにおいて、channelsにmail_debugチャンネルを追加します。

config/logging.php

...
    'channels' => [
...
        'mail_debug' => [
            'driver'    => 'single',
            'path' => storage_path('logs/mail_debug.log'),
            'level' => env('LOG_LEVEL', 'debug'),
        ],
...

出力先のログファイルは、storage/logs/mail_debug.logとしました。次に、.envにおいてMAIL_LOG_CHANNELを指定します。

.env

...
MAIL_LOG_CHANNEL=mail_debug
...

設定はこれだけです。メールを送信してmail_debug.logに出力されるか確認してみましょう。

Mail::raw('mail_log.logに出力されるはず。', fn($m) => $m->subject('Test mail')->to('test@example.com'));

mail_debug.logを確認すると意図通りにログが出力されているのが確認できるかと思います。

storage/logs/mail_debug.log

[2024-01-21 02:55:47] local.DEBUG: From: Example <hello@example.com>
Subject: Test mail
To: test@example.com
MIME-Version: 1.0
Date: Sun, 21 Jan 2024 02:55:47 +0000
Message-ID: <bbe1cccad557301198e97d3badb384f0@example.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

mail_log.logに出力されるはず。

nullチャンネルの活用

ここからは少し応用編です。config/logging.phpの設定にnullと言うチャンネルがあります。

config/logging.php

...
        'null' => [
            'driver' => 'monolog',
            'handler' => NullHandler::class,
        ],
...

これはログはどこにも出力せず破棄する設定です。以前から一体何に使うのだろう？と疑問でしたが先日、logメーラーと組み合わせる事で大量メールを送信する際のメール生成部分のパフォーマンステストに活用できる事が分かり、実際に以前の記事でkhino氏が紹介したDKIM署名のテストにおいてこれを活用しました。DKIM署名の記事はこちらです。

DKIM署名はMailableクラスのbuild()内で行うので、DKIM署名を行う場合と行わない場合でどのようにパフォーマンスが変わるのかを実際のメルマガと同じ送信件数でテストする必要がありました。ここでテストしたかったのはDKIM署名によりメール生成部分がボトルネックにならないか、のチェックであり送信部分ではありません。故に実際にメールを送信する必要は無く、生成したメールはlogメーラーでnullチャンネルに吐き出して破棄する方法を試みました。nullチャンネルを指定するには.envのMAIL_LOG_CHANNELにnullを指定するのですが、ここでも１つ工夫が必要でした。

.env

...
MAIL_LOG_CHANNEL=null
...

このように.envに指定した場合、nullは文字列ではなくnull型として扱われてしまうのです。故に、出力先のチャンネルが未指定となりdefaultチャンネルが採用されlaravel.logに送信したメールが出力されてしまいます。そこで、config/logging.phpにてnullチャンネルをコピーしたsilentチャンネルを追加し、そちらを.envで指定するようにしました。

config/logging

...
        'silent' => [
            'driver' => 'monolog',
            'handler' => NullHandler::class,
        ],
...

.env

...
MAIL_LOG_CHANNEL=silent
...

今度は意図通り、送信したメールはどこにも出力されず破棄されました。かなりニッチな活用法ですが、覚えておくと他にも色々と応用が効くかもしれません。

設定なしでカスタムログファイルを作成（２）

Sat, 17 Jun 2023 04:28:42 +0900

プログラムの中のどこからでもカスタムログを作成できるようにしたのは前回の話。今回はそのログを例えば３ヶ月ごとにローテーションしてみます。

前回のカスタムログの関数はこちらです。

ローテーションの目的

ログのファイルをローテーションする目的は、いくつかあります。１つのファイルにログを保存していると、ファイルが大きくなるのでオープンするのに時間がかかる、また、ファイルが大きくなるとディスクスペースも取られ、最悪はディスク使用率が100%となるかもしれません。ということで、ファイル名に年月を入れて必要な月数だけのファイルをキープするのがログローテーションです。

具体的な例として、現在ディレクトリに以下のようなログファイルがあるとします。

custom-2023-04.log
custom-2023-05.log
custom-2023-06.log

7/1になりログが保存されると、

custom-2023-05.log
custom-2023-06.log
custom-2023-07.log

４月のファイルが削除されて７月のファイルが作成されます。つまりいつも３ヶ月分のログファイルが存在します。

ローテーションするには

Laravelはログの管理には、phpではとても有名なMonologのパッケージを使っています。Monologはとてもフレキシブルに出来ていていろいろなカスタム化が可能です。今回はMonologのログローテーションのハンドラーを使い、月次のローテーションを設定します。

まず、RotatingFileHandlerのクラスを継承して、ファイルフォーマットの設定を、デフォルトの日次FILE_PER_DAYから、月次のFILE_PER_MONTHに設定します。

app/logging/MonthlyRotatingHandler.php

namespace App\Logging;

use Monolog\Handler\RotatingFileHandler;
use Monolog\Logger;

class MonthlyRotatingHandler extends RotatingFileHandler
{
    /**
     * @param  string  $filename　　ログファイル名
     * @param  int  $maxFiles       最高のローテーション数（0ならローテーションなし）
     * @param  string|int  $level   これがコールされる最低のログレベル（デフォルトはDEBUG）
     * @param  bool  $bubble        stackチャンネルが可能か（デフォルトはtrue）
     * @param  int|null  $filePermission ファイルの許可（デフォルトは0644）
     * @param  bool  $useLocking     書き込み中にログファイルをロックするか（デフォルトはfalse）
     */
    public function __construct(string $filename, int $maxFiles = 0, $level = Logger::DEBUG, bool $bubble = true, ?int $filePermission = null, bool $useLocking = false)
    {
        parent::__construct($filename, $maxFiles, $level, $bubble, $filePermission, $useLocking);

        $this->setFilenameFormat('{filename}-{date}', static::FILE_PER_MONTH); // デフォルトの'Y-m-d'から'Y-m'に変える
    }
}

簡単ですね。ちなみに、年次としたいなら、FILE_PER_YEARとしてください。

次に、このハンドラーを使い、前回作成したヘルパーを編集します。

app/helpers.php

use Illuminate\Support\Facades\Log;

if (! function_exists('custom_log')) {
    function custom_log($prefix, $message)
    {
        Log::build([
            'driver'     => 'monolog',
            'handler'    => App\Logging\MonthlyRotatingHandler::class,
            'with'       => [
                'filename'       => storage_path('logs/'.$prefix.'.log'),
                'filePermission' => 0666, //すべてで読み書き可能とする
                'maxFiles'       => 3, // ３ヶ月でローテーション
            ],
        ])->info($message);
    }
}

これだけです。早速テストしてみると、storage/logsには以下のようにファイルが作成されました。

$ ls -l
-rw-rw-rw- 1 kenji kenji 114 Jun 14 14:20 custom-2023-06.log
-rw-rw-rw- 1 kenji kenji   0 Jun 14 14:19 laravel.log

また、上のfilePermissionで指定したように、ファイルのパーミッションは0666となっています。

設定なしでカスタムログファイルを作成（１）

Wed, 07 Jun 2023 09:20:09 +0900

プログラムの中で必要なときにちょろっとある情報をログに残したい、しかもlaravel.logではなくカスタム（ここが大事）のログファイルを作成して残したい、というのが私の願いです。さて、どうプログラムするか？

通常は

以前にも紹介したように、カスタムのログファイルを使うには、config/logging.phpに以下のように追加して、

config/logging.php

...
    'channels' => [
        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],
...
       'custom' => [
            'driver' => 'single',
            'path' => storage_path('logs/custom.log'),
            'level' => 'info',
            'permission' => 0666,
        ],
    ],
];

と設定して、

use Illuminate\Support\Facades\Log;
...
Log::channel('custom')->info('テストだよ');

のようにコールすると、storage/logs/custom.logが作成されて渡した文字列が日時とともに記録されます。

しかし、ログファイル名を変えたいなら、いちいちconfig/logging.phpで設定しなればならないのが難点です。

オンデマンドログ

そこで登場するのがオンデマンドのログです。以下のように使います。

use Illuminate\Support\Facades\Log;
... 
Log::build([
    'driver' => 'single',
    'path' => storage_path('logs/custom.log'),
])->info('記録したいことをここに書く');
...

Logをコールするときに、どのファイルに書き込むかなどの設定もその場で指定してしまいます。しかし、今度はタイプする文字数が多いのが難点。

ヘルパーの作成

先の実行文をヘルパーにして、以下のようにコールするようにしたらシンプルになりますね。

custom_log('custom', '記録したいことをここに書く');
// storage/logs/customer.logに保存される
custom_log('invalid_email', '不正なメールアドレス：'.$request->email);
// storage/logs/invalid_email.logに保存される

このヘルパーの関数は、以下のように定義してapp/helpers.phpへ入れます。

app/helpers.php

<?php
use Illuminate\Support\Facades\Log;

if (! function_exists('custom_log')) {
    function custom_log($prefix, $message)
    {
        Log::build([
             'driver' => 'single',
             'path' => storage_path('logs/'.$prefix.'.log'),
        ])->info($message);
    }
}

そして、composer.jsonファイルを編集して、以下のようにautoloadにfilesとして含みます。

composer.json

...
    "autoload": {
        "files": [
            "app/helpers.php"
        ],
        "psr-4": {
            "App\\": "app/",
            "Database\\Factories\\": "database/factories/",
            "Database\\Seeders\\": "database/seeders/"
        }
    },
...

最後に以下を実行してローダーを更新します。

composer dump-autoload

これでLaravelのプログラムのどこでも、customer_log()を使用することができます。

Laravelでログファイルの作成（３）コマンドログファイル自動ネーミング

Mon, 26 Apr 2021 00:00:32 +0900

Artisanコマンドはコマンドラインで手動で実行するだけでなく、クロンジョブでの実行でも使用します。時間を設定して自動的に実行されるゆえに、実際に実行されたのか、どれだけ時間かかったのか、いくつのレコードを処理したのかなどをログに記録しておきたいです。そして、わかりやすいようにコマンドごとに違うログファイルを作成したいです。となると、config/logging.phpでそれぞれのコマンドのチャンネルを作成することになるのでしょうか？　つまり５０個コマンドあれば５０個のチャンネルの作成です。それは面倒だな、ということで良いアイデアを思いつきました。

要は、コマンドごとにログファイル名を変えれば良いことなので、前回の月次ごとのログの作成をベースとして変更します。

まず、config/logging.phpに新しいチャンネルcliを追加します。

config/logging.php

...
   'channels' => [
...
        'monthly' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\MonthlyFileNameForRotatingHandler::class],
            'path' => storage_path('logs/laravel.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],

        'cli' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\CommandFileNameForRotatingHandler::class],
            'path' => storage_path('logs/cli.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],
...

前回のmonthlyのチャンネルの設定と比較すると、変わっているのはtapで指定したクラス名とpathのログファイル名だけです。

そして、以下の新規のクラスの定義は、これまた前回のMonthlyFileNameForRotatingHandlerクラスとほとんど変わりません。

app/Logging/CommandFileNameForRotatingHandler.php

namespace App\Logging;

class CommandFileNameForRotatingHandler
{
    /**
     * Customize the given logger instance.
     *
     * @param  \Illuminate\Log\Logger  $logger
     * @return void
     */
    public function __invoke($logger)
    {
        foreach ($logger->getHandlers() as $handler) {
       	    $name = $_SERVER['argv'][1]; //実行されるArtisanのコマンド名を取得して、以下でそれを使用
            $handler->setFilenameFormat("{filename}-$name-{date}", 'Y-m');
        }
    }
}

変更した部分は、ファイル名の作成の部分だけです。そして、この設定により以下のようなコマンドラインを実行するなら、

$ php artisan command:log

作成されるログファイル名は、cli-command:log-2021-04.logのようになります。

違うコマンドを実行するなら、

$ php artisan task:something

ログファイル名は、cli-task:something-2021-04.logとなります。

もちろんArtisanのコマンドでは以下の例のように、Logの関数のコールが必要です。

app/Console/Commands/LogCommand.php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Log;

class LogCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:log {action} {--option=}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        Log::channel('cli')->info('start', $_SERVER['argv']); // ここでcliのチャンネルを使用してコール

        return 0;
    }
}

上のコマンドを実行すると、cli-command:log-2021-04.logの中身は、以下のようになります。 info()の２番目の引数には配列を渡すことが可能です。ここではコマンドラインの引数を記録します。

$ php artisan command:log run --option=x
$ cat storage/logs/cli-command:log-2021-04.log
[2021-04-24 23:45:46] local.INFO: start ["artisan","command:log","run","--option=x"]

→ ログに関しての他の記事

LaravelでLogファイルの作成（２）ログファイルをローテーション

Mon, 19 Apr 2021 00:00:25 +0900

デフォルトのインストールでは、laravel.logは日次ではローテーションされません。つまり一生同じファイルにエラーなどが記録され続けます。それが嫌ならどうしましょう？

日次でローテーション

これは次のファイルの変更で簡単に設定可能です。

config/logging.php

...
   'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['daily'], // これをsingleからdailyに変換
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],

        'daily' => [
            'driver' => 'daily',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
            'days' => 14, // 14日でローテーション
        ],
...

こうすると、作成されるファイルは、laravel.logから、laravel-YYYY-MM-DD.logの形式に変わります。

$ ls -l 
-rw-r--r-- 1 kenji kenji    51 Apr  9 14:51 laravel-2021-04-09.log
-rw-r--r-- 1 kenji kenji 18525 Apr  3 13:14 laravel.log

そして14日経過したら、それ以前に作成されたログファイルは削除されます。つまりファイルのローテーションが実行されます。

月次でローテーション

さて、日次のローテーションではあまりにも頻繁過ぎると思うなら、今度は月次に変更してみましょう。

これはちょっと準備が要ります。デフォルトやマニュアルには直接の例がないのでちょっと調査必要でしたが可能です。

まず、以下のファイルを作成します。

app/Logging/MonthlyFileNameForRotatingHandler.php

namespace App\Logging;

class MonthlyFileNameForRotatingHandler
{
    /**
     * Customize the given logger instance.
     *
     * @param  \Illuminate\Log\Logger  $logger
     * @return void
     */
    public function __invoke($logger)
    {
        foreach ($logger->getHandlers() as $handler) {
            $handler->setFilenameFormat('{filename}-{date}', 'Y-m');
        }
    }
}

それから、以下のように新規のチャンネルmonthlyの作成が必要です。

config/logging.php

...
   'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['monthly'], // これをmonthlyに変換
            'ignore_exceptions' => false,
        ],
...
        'monthly' => [
            'driver' => 'daily', // use RotatingHandler
            'tap' => [App\Logging\MonthlyFileNameForRotatingHandler::class],
            'path' => storage_path('logs/laravel.log'),
            'level' => 'info',
            'permission' => 0666,
            'days' => 12, // １２ヶ月でローテーション
        ],
...

この設定をすると、今度はファイル名はlaravel-YYYY-MM.logの形式に変わります。以下のように。

$ ls -l
-rw-r--r-- 1 kenji kenji 143 Apr  9 14:55 laravel-2021-04-09.log
-rw-rw-rw- 1 kenji kenji  45 Apr  9 15:12 laravel-2021-04.log

月次なのに‘days’ => 12とちょっと設定が変ですが、ローテーションの仕組みはそこで指定した数のファイルをキープして他のファイルは削除するというものなので、この場合は12日ではなく12ヶ月となります。ちなみに、どのファイルが削除されるかはファイルの日付ではなくファイル名順で決まるのでローテーションのテストをするならダミーのファイルを作成してテスト可能です。

最後に、ファイルのローテーションが要らないなら、そこには0と指定してください。永遠に作成された月次のファイルが残り続けます。

→ ログに関しての他の記事

LaravelでLogファイルの作成（１）laravel.logでないファイルに記録

Mon, 05 Apr 2021 00:00:17 +0900

ログファイルを作成するのは、デバッグのためや後のチェックに使われるために実行の記録を残すなど、いろいろな目的で使われます。Laravelでは、laravel.logというファイルがデフォルトでstorage/logsに作成されて、そこでいろいろな情報を記録するのに使われます。しかし、特定のプログラムの実行でlaravel.logではないファイルにログを残したいときはどうしましょう？

Laravelではこれはいたって簡単。

まず、config/logging.phpのファイルをエディターで開いて、以下のようにcustomのチャンネルを追加します。

config/logging.php

...
    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single'],
            'ignore_exceptions' => false,
        ],

        'single' => [
            'driver' => 'single',
            'path' => storage_path('logs/laravel.log'),
            'level' => 'debug',
        ],
...
       'custom' => [
            'driver' => 'single',
            'path' => storage_path('logs/custom.log'),
            'level' => 'info',
            'permission' => 0666,
        ],
    ],
];

そして、tinkerでログを書き込みます。

>>> Log::channel('custom')->info('テストだよ');
=> null

以下のように、custom.logのファイルが作成されています。上の設定ではパーミッションがlaravel.logと異なることに注意してください。デフォルトではpermissionは0644ですが上の設定では0666として誰もが読み書き自由となっています。

$ ls -l storage/logs
-rw-rw-rw- 1 kenji kenji    52 Apr  3 14:17 custom.log
-rw-r--r-- 1 kenji kenji 18525 Apr  3 13:14 laravel.log

そしてファイルの中身は、

$ cat storage/logs/custom.log
[2021-04-03 21:17:05] local.INFO: テストだよ

ちゃんと書き込まれていますね。

もう１つテストです。今度は、info()でなくdebug()の関数を使います。

>>> Log::channel('custom')->debug('デバッグだよ')
=> null

ファイルの中身をチェックすると、

$ cat storage/logs/custom.log
[2021-04-03 21:17:05] local.INFO: テストだよ

書き込みがありません。これは、設定でlevelをinfoと設定したためです。infoの下のレベルであるdebugでは書き込みが起こらないのです。

ちなみに以下がレベルのランクです。

Log::emergency($message);
Log::alert($message);
Log::critical($message);
Log::error($message);
Log::warning($message);
Log::notice($message);
Log::info($message);
Log::debug($message);

→ ログに関しての他の記事