CakePHP4 $this->log() Typeについて

Question

前提・実現したいこと

cakephp4
php7.4.11

debug.logファイルにログを出力するときに
Typeエラーが出て、配列を書き込めません。
CakePHP2では普通に出力できていたのに
CakePHP4で何かが変わったのでしょうか？
何かの設定が必要になったのでしょうか？
ご教授のほどよろしくお願いします。

発生している問題・エラーメッセージ

Argument 1 passed to Cake\Controller\Controller::log() must be of the type string, array given,

該当のソースコード

namespace App\Controller\Test;
class TestssController extends AppController
{
  public function index()
  {
    $array = array("a"=>"fff","d"=>"fff");
    $this->log($array,'debug');
  }
}

LOGに関する設定は以下の通りです。

app.php
    'Datasources' => [
       ・・・
       'log' => true,
       ・・・
     ]

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

app_local.php
   'debug' => filter_var(env('DEBUG', true), FILTER_VALIDATE_BOOLEAN),

Answer 1

CakePHP 3以降、ロギングメソッドはPSR-3のLoggerInterfaceの実装となり、CakePHP 4以降では文字列型しか受け付けなくなっています。

参考: 4.0 移行ガイド - 4.x

CakePHP 4.1以降では、オブジェクトを文字列化してログに記録するには、第3引数の$contextを利用するのとよいでしょう。

参考: : Using Placeholders in Messages - Logging - 4.x

use Cake\Log\Log;
use Psr\Log\LogLevel;

Log::error('Could not process for user={user}', ['user' => $user]);

// LogTraitの logメソッドであれば
$this->log('Could not process for user={user}', LogLevel::ERROR, ['user' => $user]);

4.0系であれば、json_encodeなどでオブジェクトをシリアライズして記録すればよいでしょう。

Comments

[nojimage]

なお、メッセージのコンテキストプレイスホルダーの展開はCake\Log\Engine\BaseLog.php の _formatメソッドにより実現されています。オブジェクトの内容をシリアライズする方法の優先順位についてはコードを見てください。 https://github.com/cakephp/cakephp/blob/4.2.1/src/Log/Engine/BaseLog.php#L96

[MKannna]

ご回答ありがとうございます。
まだまだ用語を理解できておらず、クックブックなど読んでも
やるべき内容がどれなのかわからなかったのですが、
アドバイスをいただいた上でリンクを読むと理解がしやすかったです。
おかげ様で、求めていた結果をえられました。

プレイスホルダーとは、シリアライズとは...
全然分からなかったので、調べて、ようやく理解ができました。

重要なのは第１引数の"{user}"と第２引数の’user’で
これが一致していないと、シリアライズできないということがわかりました。
ただ、このままだと見づらいので、
Log::error('user={user}', ['user' => print_r($user,true)]);
として、見やすい形でログに記録することができました。
また、色々試して
$this->log(print_r($users, true),'debug');
こちらでも同じ結果が出ましたので、
タイピング数が少ないこちらを採用しようかと思います。

ご丁寧に回答いただき本当にありがとうございました。

[MKannna]

追記いただきました、
シリアライズする方法の優先順位について
コードを見たのですが
すみません、よくわからなかったです。
どういう状況の時に必要になるのでしょうか？

[nojimage]

シリアライズ方法の優先順位は、オブジェクトをログに出力する際に関係してきます。不要な情報をログに書き出さないために必要になってきます。対象のオブジェクトにあるシリアライズ用のメソッドで出力する内容をコントロールできます。
例えば、jsonSerializeインターフェースを継承したクラスのオブジェクトならjsonSerializeメソッドがシリアライズの際に使用されるのでそこで出力する内容をコントロールできます。CakeのEntityなら$_hiddenプロパティに列挙したフィールドは出力されなかったりしますね。
これにより、センシティブな内容（パスワードやカード情報など）を含むオブジェクトを安易にログに出力にしてしまい、そこから情報漏えいしたという被害を防ぐことができます。

[MKannna]

ご丁寧に解説ありがとうございました。
改めてコードを見てみたところ、シリアライズ化をどのように行っているかがなんとなくわかりました。
出力する内容のコントロールをどうすればいのかまでは
まだ勉強不足で分かりませんが、そういうことができるということと
ログ出力で情報漏洩が起きる事を知りませんでしたので
それを念頭に入れて、今後作業を進めていきながら学んで行きたいと思います。

Answer 2

Argument 1 passed to Cake\Controller\Controller::log() must be of the type string, array given,

まんま言ってますが。

日本語訳）「Cake\Controller\Controller::log()の第一引数は文字列型です。現状、配列型を渡しています。」

Comments

[MKannna]

ご回答ありがとうございます。
説明がわかりずらくてすみません。

型が違うと怒られているのは分かっているのですが
ログファイルに配列型、オブジェクト型を表示するにはどうしたらいいいのかがわかりません。

そもそも使い方が間違っているのでしょうか？
何か設定が必要なのでしょうか？
何かの設定が間違っているのでしょうか？

お手数おかけしてすみませんが、
ご教授のほどよろしくお願いします。