投稿2023/06/13 11:56
編集2023/06/13 12:15Laravelを使って社内で使用するアプリを作成しています。要件としてはユーザーである社員がどういった操作を行ったのかイベント単位で全てのログを記録したいです。
ただログに関しての知識があまりにもないため、どのように実装するのが良いのか判断がつかないでいます。考えていることのいずれもやりたい事自体の実現は出来るとは思っているのですがLaravelでの開発が初めてかつ、経験のある言語でもログの出力方法を検討した事がないため助言頂けないでしょうか。
愚直にLogファサードで記述する。
以下参考にミドルウェアを作成する。
https://e-seventh.com/laravel-middleware-tracelog/
https://github.com/ytake/Laravel-Aspect
Laravel9.x
回答1件
0
自己解決
お知り合いの方からミドルウェアで実現したら良いのではと回答頂きました。
また、チャネルごとに出力レベルも変更できるということも教えてもらったので試験的に試したソースコードを記載しておきます。
コピペの継ぎ接ぎなのでそのまま使用すると良くない箇所が多々あるかもですが以下をベースにしつつ修正していけば問題ないかなっといった具合です。
参考にさせていただいたサイトは以下です。
config/logging.php
php
1'channels' => [ 2 ..... 3 4 'accessLog' => [ 5 'driver' => 'custom', 6 'via' => App\Logging\AccessLogger::class, 7 'path' => storage_path('logs/access/access.log'), 8 'level' => 'info', // ログレベル info 以上だけ出力 9 'days' => 31, // 31日分のログを保持する ※31日ではない月を考慮できてないので検討必要 10 ], 11 12 'sqlQueryLog' => [ 13 'driver' => 'custom', 14 'via' => App\Logging\CreateSQLQueryLogger::class, 15 'path' => storage_path('logs/sql/sql.log'), 16 'level' => 'debug', // ログレベル debug 以上だけ出力 ※環境ごとに切り替えれるように修正必要 17 'days' => 14, // 14日分のログを保持する 18 ],
app/Providers/AppServiceProvider.php
php
1public function boot(): void 2 { 3 \DB::listen(function($query) { 4 $str = $query->time.' ms -> '.$query->sql; 5 if ($query->bindings) { 6 $str .= "\n".'bind: '.var_export($query->bindings, true); 7 } 8 \Log::channel('sqlQueryLog')->debug($str); 9 }); 10 }
app/Logging/CreateSQLQueryLogger.php
php
1<?php 2 3namespace App\Logging; 4 5use Monolog\Logger; 6use Monolog\Handler\RotatingFileHandler; 7use Monolog\Formatter\LineFormatter; 8 9class CreateSQLQueryLogger 10{ 11 /** 12 * SQLクエリ用Monologインスタンス生成 13 * @param array $config 14 * @return \Monolog\Logger 15 */ 16 public function __invoke(array $config) 17 { 18 // 引数の $config には、config/logging.php で sqlQueryLog に設定した path とか days とかが入ってる！ 19 20 // 'debug' とかの文字列をMonologが使えるログレベルに変換 21 $level = Logger::toMonologLevel($config['level']); 22 23 // 日ごとにログローテートするハンドラ作成 24 $hander = new RotatingFileHandler($config['path'], $config['days'], $level); 25 26 // 改行コードを出力する＆カラのコンテキストを出力しないフォーマッタを設定 27 $hander->setFormatter(new LineFormatter(null, null, true, true)); 28 29 // Monologインスタンス作成してハンドラ設定して返却 30 $logger = new Logger('SQL'); // ロガー名は 'SQL' にした。これはログに出力される 31 $logger->pushHandler($hander); 32 return $logger; 33 } 34}
ここまででSQLのログ出力が出来るようになっている。
app/Logging/AccessLogger.php
php
1<?php 2 3namespace App\Logging; 4 5use Monolog\Logger; 6use Monolog\Handler\RotatingFileHandler; 7use Monolog\Formatter\LineFormatter; 8 9class AccessLogger 10{ 11 /** 12 * アクセスログ用Monologインスタンス生成 13 * @param array $config 14 * @return \Monolog\Logger 15 */ 16 public function __invoke(array $config) 17 { 18 // 引数の $config には、config/logging.php で accessLog に設定した path とか days とかが入ってる！ 19 20 // 'debug' とかの文字列をMonologが使えるログレベルに変換 21 $level = Logger::toMonologLevel($config['level']); 22 23 // 日ごとにログローテートするハンドラ作成 24 $hander = new RotatingFileHandler($config['path'], $config['days'], $level); 25 26 // 改行コードを出力する＆カラのコンテキストを出力しないフォーマッタを設定 27 $hander->setFormatter(new LineFormatter(null, null, true, true)); 28 29 // Monologインスタンス作成してハンドラ設定して返却 30 $logger = new Logger('access'); // ロガー名は 'access' にした。これはログに出力される 31 $logger->pushHandler($hander); 32 return $logger; 33 } 34}
まずはmiddlewareを以下コマンドで生成
shell
1php artisan make:middleware AccessLog
app/Http/Middleware/AccessLog.php
php
1<?php 2 3namespace App\Http\Middleware; 4 5use Closure; 6use Illuminate\Http\Request; 7use Illuminate\Support\Facades\Log; 8use Symfony\Component\HttpFoundation\Response; 9 10class AccessLog 11{ 12 /** 13 * Handle an incoming request. 14 * 15 * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next 16 */ 17 public function handle(Request $request, Closure $next): Response 18 { 19 $response = $next($request); 20 21 // リクエスト終了時のログ 22 Log::channel('accessLog')->info('end ' . $request->url()); 23 24 return $response; 25 } 26}
ここまででアクセスログの出力が出来るようになっている。
ソースコード自体は参考サイトを基に使わせてもらっているのですが
恐らくSQLログの方もAppServiceProviderに記述するのではなくMiddlewareとして切り出せるのではないかと思うので実際のアプリケーション作成時には試してみようと思います。
投稿2023/06/13 14:58
総合スコア11
あなたの回答
tips
プレビュー
Q&A
