CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説

2024/06/25 2024/06/27

CakePHP4で独自のログファイルを作成してログ出力方法を解説

　
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法や、新しいログ出力のファイルを設定する方法を解説します。
　
　

CakePHP4のデフォルトログファイル「debug.log」「error.log」にログ出力する方法

　
CakePHP4では、デフォルトで「debug.log」「error.log」「queries.log」のログが用意されています。
　
コントローラーに下記のように記述すると、それぞれ「debug.log」「error.log」にログ出力をすることができます。
　

// debug.log にログを出力する
$this->log("ログテスト０１","debug");

// error.log にログを出力する
$this->log("ログテスト０２","error");

// debug.log にログを出力する

$this->log("ログテスト０１","debug");

// error.log にログを出力する

$this->log("ログテスト０２","error");

　
第一引数がメッセージで、第二引数が「ログレベル」による出力先の指定です。
　
この方法は、「debug」レベルのメッセージは「debug.log」ファイルに、「error」レベルのメッセージは「error.log」に、と言うデフォルトで設定されている「ログレベル」によるログの出力先を指定する方法を利用したものです。
　
　
今回は、このデフォルトの設定以外に、独自のログファイルを作成し、条件によってログを出力し分ける方法を解説します。
　
例えば、
「Info（インフォメーションメッセージ）」は「info.log」に出力する
「UsersController.php」でのログは「users.log」に出力する
と言った感じの設定をしたいと思ったときの対応方法です。
　
　
ちなみに私は、ロギングスコープを使用して、処理毎にログを分けていく方法が好きですね。
　
　

ログ出力の設定は「/config/app.php」に記述する

　
ログ出力処理の設定は「/config/app.php」に記述されています。
インストールした直後の状態では、350行目くらいから「debug」のログの設定が記述されています。（バージョン等によって少し異なるかと思いますが。）
　
それに続けて「error」「queries」のログの設定がありますので、独自のログ設定は「queries」の設定に続けて記述するといいでしょう。
　
例えば、「sampleError.log」と言うログ出力をする場合の設定は下記となります。
　

    'sampleError' => [
      'className' => FileLog::class,
      'path' => LOGS,
      'file' => 'sampleError',
      'url' => env('LOG_SAMPLE_ERROR_URL', null),
      'scopes' => ['sampleErrorScope'],
      'levels' => ['notice', 'info', 'debug', 'warning', 'error', 'critical', 'alert', 'emergency'],
      'mask' => 0666,
      'rotate' => 5,
      'size' => '10MB',
    ],

'sampleError' => [

'className' => FileLog::class,

'path' => LOGS,

'file' => 'sampleError',

'url' => env('LOG_SAMPLE_ERROR_URL', null),

'scopes' => ['sampleErrorScope'],

'levels' => ['notice', 'info', 'debug', 'warning', 'error', 'critical', 'alert', 'emergency'],

'mask' => 0666,

'rotate' => 5,

'size' => '10MB',

　
1行目の「'sampleError' => [」はログの名称です。
1文字目を小文字で書くローワーキャメルケースで書くようです。
　
【className】
ログエンジンを指定。標準は CakePHPのログ出力処理を利用する「FileLog::class」となる。
その他、ログの標準出力機能を利用する場合は「SyslogLog::class」を指定し、ログ出力のプラグインを利用する場合はこの項目で指定をする。
今回は CakePHPの標準である「FileLog::class」の解説となる。
　
【path】
ログファイルを出力するフォルダを指定。デフォルトの出力先は「LOGS（/logs）」。
　
【file】
出力するログのファイル名。
　
【url】
　
　
【scopes】
「ロギングスコープ」と言う機能を利用してログ出力をする場合に指定する。ローワーキャメルケースで書くようだ。
「scopes」の設定をすると、スコープを指定しないログは出力対象にならない。スコープを使用しない場合は「false」を指定する。
　
また、「scopes」を指定していても、次項の「levels」の対象になっていない場合はログは出力されない。
また、「['sampleErrorScope01','sampleErrorScope02']」のように複数指定することもできる。
　
【levels】
出力対象とするレベルを指定する。
指定できるレベルは以下のもの。
　Emergency：システムは使用出来ません
　Alert：今すぐ行動する必要がある
　Critical：致命的な状態
　Error：エラー状態
　Warning：警告状態
　Notice：正常であるが、重大な状態
　Info：インフォメーションメッセージ
　Debug：デバッグレベルメッセージ
「'levels' => [],」のように「levels」を空にした場合はすべてのレベルを出力する。
　
【mask】
出力するログファイルのパーミッションの指定。「0666」「0755」のように指定する。
指定しない場合はその環境のデフォルトのパーミッションが使われる。
　
【rotate】
ログファイルをローテーションする場合はそのファイル数を数値で指定する。ローテーションしない場合は「false」を指定する。
指定しない場合はデフォルトの「10」となる。
　
【size】
ローテーションする場合の 1ファイルのファイル上限サイズを「2MB」「100KB」のように指定する。
指定しない場合はデフォルトの「10MB」となる。
　
　
path、file、mask、rotate、sizeなどは、classNameの設定で「FileLog::class」を指定した場合に有効になります。
　
また、【path】のところで説明した「LOGS」フォルダですが、CakePHPではシステム上で定義されている定数がいくつかあります。
それについては下記に記事を書いていますので、併せて参考にしてください。
CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数
　
　

ログを出力するコントローラー、モデルでの処理

ログレベル（levels）を指定してログ出力をする場合の処理

　
ログレベル（levels）を指定してログ出力をする場合の処理は、一番最初に記載したように、下記の記述をします。
　
コントローラーに記述する場合は下記になります。
　

// debug.log にログを出力する
$this->log("ログテスト０１","debug");

// error.log にログを出力する
$this->log("ログテスト０２","error");

// debug.log にログを出力する

$this->log("ログテスト０１","debug");

// error.log にログを出力する

$this->log("ログテスト０２","error");

　
　
モデルに記述する場合は下記になります。
　

// まず最初に use句を追記する
use Cake\Log\Log;

1 2	// まず最初に use句を追記する use Cake\Log\Log;

　
use句の「use Cake\Log\Log;」の記述を忘れると、「Class "App\Model\Table\Log" not found」と言うエラーが出力されます。
　
続いて、各処理の中に下記を記述します。
　

// 「debug」レベルのログを「debug.log」に出力する場合
Log::debug("デバッグです");

// 「error」レベルのログを「error.log」に出力する場合
Log::error("エラーです");

// 「debug」レベルのログを「debug.log」に出力する場合

Log::debug("デバッグです");

// 「error」レベルのログを「error.log」に出力する場合

Log::error("エラーです");

ログレベル（levels）を指定して複数のログに出力をする場合の処理

    'debug' => [
      'className' => FileLog::class,
      'path' => LOGS,
      'file' => 'debug',
      'url' => env('LOG_DEBUG_URL', null),
      'scopes' => false,
      'levels' => ['notice', 'info', 'debug'],
    ],
    'debug2' => [
      'className' => FileLog::class,
      'path' => LOGS,
      'file' => 'debug2',
      'url' => env('LOG_DEBUG_URL', null),
      'scopes' => false,
      'levels' => ['notice', 'info', 'debug'],
    ],

'debug' => [

'className' => FileLog::class,

'path' => LOGS,

'file' => 'debug',

'url' => env('LOG_DEBUG_URL', null),

'scopes' => false,

'levels' => ['notice', 'info', 'debug'],

'debug2' => [

'className' => FileLog::class,

'path' => LOGS,

'file' => 'debug2',

'url' => env('LOG_DEBUG_URL', null),

'scopes' => false,

'levels' => ['notice', 'info', 'debug'],

　
上記のように「/config/app.php」に「levels」の設定に「debug」が複数のログ設定にある場合、下記の「debug」のログレベルを指定してログ出力した場合は、「debug.log」「debug2.log」の両方にログ出力されます。
　

// debug.log debug2.logの両方にログを出力する
$this->log("ログテスト０１","debug");

1 2	// debug.log debug2.logの両方にログを出力する $this->log("ログテスト０１","debug");

ロギングスコープ（scopes）を指定してログ出力をする場合の処理

　
ロギングスコープ（scopes）を指定してログ出力をする場合の処理は、下記を記述します。
　
　

コントローラーでロギングスコープを指定する方法

　
コントローラーに記述する場合はでは下記を記述します。
　

// 「sampleErrorScope」のスコープを指定する場合
$this->log("エラーです", "error", ["scope" => ["sampleErrorScope"]]);

1 2	// 「sampleErrorScope」のスコープを指定する場合 $this->log("エラーです", "error", ["scope" => ["sampleErrorScope"]]);

　
第一引数が、エラーメッセージ。
第二引数が、ログレベル。
第三引数が、その他の設定で、上記は「ログスコープ」を指定しています。
第三引数で指定するスコープは「scopes」で指定した名称です。
上記の例では「sampleError」と記述しているログの名称の方ではありませんのでご注意ください。（とは言え「scopes」の値を「sampleError」と同じ文字列にする場合が多いんですが。）
　
ちなみに、「scope」で指定した値が、「app.php」内の「scopes」で設定しているものに存在しない場合でもエラー等の発生はありません。
もちろんログも出力されませんので、出力されているハズのログが出力されていない場合は「scope」の値が間違っているのかもしれません。
　
　

モデルでロギングスコープを指定する方法

　
モデルでは下記を記述します。
　

// まず最初に use句を追記する
use Cake\Log\Log;

1 2	// まず最初に use句を追記する use Cake\Log\Log;

　
// 「sampleErrorScope」のスコープを指定する場合
// 「error」レベルのログを「error.log」に出力する場合
Log::error("エラーです", ["scope" => ["sampleErrorScope"]]);

// 「sampleErrorScope」のスコープを指定する場合

// 「error」レベルのログを「error.log」に出力する場合

Log::error("エラーです", ["scope" => ["sampleErrorScope"]]);

　
最初の「Log::error」の「error」の部分がエラーレベル。
第一引数が、エラーメッセージ。
第二引数が、その他の設定で、上記は「ログスコープ」を指定しています。
　
　

CakePHP4で配列、オブジェクトを出力する場合は「var_export()」を使用する

　
CakePHP4からは、配列やオブジェクトをログ出力する際に「var_export()」を使用する必要があります。
CakePHP3も CakePHP4も基本的なログの設定方法、出力の指定方法などは変わらないのですが、なぜかこの配列やオブジェクトを直接出力してくれなくなっています。
　

$sampleArray = [
  "aaa" => "aaa01",
  "bbb" => "bbb01",
];

// CakePHP3までの配列をログ出力する際の記述方法（CakePHP4ではエラーになる）
$this->log($sampleArray,"debug");

// CakePHP4から配列をログ出力する際の記述方法
$this->log(var_export($sampleArray,true),"debug");

$sampleArray = [

"aaa" => "aaa01",

"bbb" => "bbb01",

];

// CakePHP3までの配列をログ出力する際の記述方法（CakePHP4ではエラーになる）

$this->log($sampleArray,"debug");

// CakePHP4から配列をログ出力する際の記述方法

$this->log(var_export($sampleArray,true),"debug");

　
CakePHP3までは配列やオブジェクトの変数もそのまま記述すれば、いい感じでログに出力をしてくれていましたが、CakePHP4からは「var_export()」を利用して出力する必要があります。
　
「var_export()」を付けないと下記のエラーが発生します。
　
「Cake\Controller\Controller::log(): Argument #1 ($message) must be of type string, array given, called in C:\xampp\htdocs\src\Controller\SamplesController.php on line 333」
　
また、「var_export()」の第二引数の「true」もお忘れなきよう。
　
　
さらに「var_export()」についてもう少し詳しく知りたい、「print_r」「var_dump」と何が違うの？と思った方は下記に解説記事を書いていますので併せて参考にしてください。
PHPのデバッグで使う print_r、var_dump、var_exportの動作の違い
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

: CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法

CakePHPのバージョンの調べ方2点を紹介。CakePHP3～CakePHP5は共通だが CakePHP2はフォルダ構成が異なるためコマンドのパスもオプションも異なる。

: CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。