ログを表示!Laravelでlogを出力させる方法【初心者向け】

初心者向けにLaravelでlogを出力させる方法について解説しています。log(ログ)の出力は開発やデバッグを行う上で欠かせない知識です。実際にソースコードを書いて説明しているので、参考にしてみてください。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Laravelでlogを出力させる方法について解説します。

実際にログを表示する書き方について説明しているので、自分でも同じように書いてみてください。

 

なお本記事は、TechAcademyのPHP/Laravel講座の内容をもとに紹介しています。

 

田島悠介

今回は、Laravelに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Laravelでlogを出力させる方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

logとは

アプリケーションは、1つのリクエストを取っても様々な処理が行われており、機能を維持しつつ拡張していかなければいけません。そのためにアプリケーションの状態を記録として残しておくことがログの役割です。

処理の中で適切にロギングすることで、開発する上で重要な情報を得ることができます。身近なことでいうとデバッグです、「この入力の時にこの処理起こるのおかしいな?どんな値として渡されているんだろう?」などロギング処理を埋め込むことで処理途中のアプリケーションの状態の一部を確認することができます。

 

logを表示させる方法、logの出力レベルの変更方法

Laravelでのログの表示方法は Logファサードを使用するのがいいと思います。ログのレベル(重要度) に応じてemergency、alert、critical、error、warning、notice、info 、debug を使い分けてください。

例えばデバッグ情報であれば \Log::debug($params) など、警告を表示したければ\Log::warning(‘This method is duplicated. Please use another one Hoge::fuga’) のように呼び出すメソッド名がログレベルに対応しています。

ログの出力先はデフォルトでは storage/logs/laravel.logになります。このあたりの設定を変更したい場合は公式ドキュメントを参照ください。ログを見ながら開発したくなったらtail -f storage/logs/laravel.log や less +F storage/logs/laravel.logなどを別コンソールで実行しておくといいかもしれません。

 

[PR] PHPのプログラミングで挫折しない学習方法を動画で公開中

実際にlogを出力させてみる

適当なコントローラのアクションのレスポンスを返す前のあたりに \Log::info(‘ログ出力テスト’); という行を追加して見てください。そのアクションを呼び出すルーティングにアクセスするとstorate/logs/laravel.logに

[Y-m-d h:i:s] local.INFO: ログ出力テスト

というログが一行追記されることがわかるかと思います。

適当なコントローラが存在しない場合は作成しましょう。 php artisan make:controller LogTestControllerなどでコントローラーを作成したのち、routes/web.phpにRoute::get(‘log_test’, ‘LogTestController@index’); というLogTestControllerのindex メソッドに対するルーティングを行い、LogTestControllerにindexメソッドを追加してあげてください。

レスポンスは特に気にせず、 return「log test」; など文字列を返してあげて、それより前の部分にLogファサードを使ったロギング処理を入れてあげてください。

LogTestControllerにロギング処理を追加したサンプルコード

<php

namespace App\Http\Controllers;

class LogTestController extends Controller
{
    public function index()
    {
        \Log::info(‘ログ出力テスト’);
        return 'log test';
    }
}

以上が簡単なログ出力方法の説明になりました。なおデバッグログは別として、ログの扱いはプロダクト単位でルールを決めていくのがいいと思います、どういう形式で出力するかなど、統一されていた方が後々の取り回しが、読むにしても何かのツールに食べさせるにしても、便利です。

また、リクエストの内容をロギングしていると、パスワードなどが平文の状態でログファイルに記録されてしまうことがあるので何をロギングしているかは常に注意が必要になるかと思います。

この記事を監修してくれた方

鵜澤峻平(うさわしゅんぺい)

普現在はフリーランスのエンジニアをしていてプログラミング歴は5年目になります。普段はRails、Laravel、Node.js等を使ってWeb、モバイルアプリケーションを作成しています。開発実績としては、いくつかのWebサービス、コンシューマー向けモバイルアプリケーション、NPO サイトリニューアル、ロボット用プログラムなどがあります。

TechAcademyでメンターをはじめたのは、「プログラミングでやりたいことがある人を応援したい」、「講師と受講者が話し合って学び方を決めていく」に惹かれたからです。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

オンラインのプログラミングスクールTechAcademyではオンラインブートキャンプPHP/Laravelコースを提供しています。

PHPやフレームワークのLaravelを使ってWebアプリケーションの開発を学ぶことができます。

現役エンジニアがパーソナルメンターとして受講生に1人ずつつき、マンツーマンのメンタリングで学習をサポートし、最短4週間で習得することが可能です。

また、現役エンジニアから学べる無料のプログラミング体験会も実施しているので、ぜひ参加してみてください。