こんにちは!
MagentoおよびAdobe Commerce(以下まとめてMagento)のデバッグなどで、ソースコード内に一時的にログ出力を仕込みたい時、毎回やり方を忘れるので備忘録を兼ねてブログに記したいと思います。
いきなり、コード例
すぐ使えるように早速コード例を書いておきます。もうコレをコピペするだけ。簡単です。
\Magento\Framework\App\ObjectManager::getInstance()->get(\Psr\Log\LoggerInterface::class)->info('メッセージ');
複数個所にログ出力を仕込む場合は、変数でオブジェクトを用意して使いまわす方が効率的。
$logger = \Magento\Framework\App\ObjectManager::getInstance()->get(\Psr\Log\LoggerInterface::class);
:
$logger->info('メッセージ1');
:
$logger->info('メッセージ2');
:
$logger->info('メッセージ3');
この様にログ出力のソースコードを入れると、<magento_root>/var/log/system.log 等にログが出力されます。
もうちょっとマシなやり方
一時的に入れる場合は冒頭のようなコードでもいいのですが、モジュールの一部としてログ出力を組み込んでしまう場合はクラスの宣言でMagentoのお作法の1つDI※に基づいた組み込み方をしておくほうが使い勝手が良いのでそうしましょう。
※DI = Dependency Injection（依存性注入）
Adobe Commerce Developer Guide - Dependency injection
Magentoの標準のログのクラスは、Psr\Log\LoggerInterfaceとしてdi.xmlが定義されているので、コンストラクタの引数内でこのインターフェイスを持つオブジェクトを受け取るように指定するだけで自動的にオブジェクトが生成されて受け取れます。これをクラスのメンバー変数にセットしておけば、クラス内のどこでもログ出力が出来ます。
コード例
<?php
namespace FutureSpirits\Sample\Block;
use Magento\Framework\View\Element\Template\Context;
use Psr\Log\LoggerInterface;
class SampleBlock extends \Magento\Framework\View\Element\Template
{
protected $logger;
public function __construct(
Context $context,
LoggerInterface $logger, // LoggerInterfaceのオブジェクトを受け取る
array $data = []
) {
$this->logger = $logger; // メンバ変数に格納
parent::__construct($context, $data);
}
public function test()
{
$this->logger->info('メッセージ'); // ログ出力
}
}
Magentoやエクステンションのモジュールによってはログ出力用のメンバ変数が最初から用意されているものもあります。先ほどのソースコードはブロックのソースコード例ですが、実はブロックのクラスには既に $this->_logger というログ出力用のメンバ変数が用意されているので、自前の物を用意する必要は無く下記の様にするだけでOKです。
<?php
namespace FutureSpirits\Sample\Block;
class SampleBlock extends \Magento\Framework\View\Element\Template
{
public function test()
{
$this->_logger->info('メッセージ'); // ログ出力
}
}
全ての場面で一様にこのようなものが用意されているわけではないので、使える場合はそれを使い、無い場合は自前で用意して使う。という事になります。（これをいちいち覚えていられないので一時的な場合は冒頭のようなコードを入れることが多いです）
おまけ
ログ出力での色々な使い方
ログレベルの使い分け
ログレベルは、debug、info、notice、warning、error、critical、alert、emergencyがありログの種類を明確にしたい時に使い分けますが。普段デバッグ時によく使うのは、debugとinfoあたりです。
$logger->info('メッセージ'); ・・・とりあえずログを取りたい時はこれ。system.logおよびdebug.logの両方に出力されます。
$logger->debug('メッセージ'); ・・・debug.logのみに出力されます。また動作モードがproduction modeの場合は出力自体がされません。
コンテキストの出力
第2引数にはコンテキストを渡せます。変数の内容などを確認したいときに便利です。中身がログに出力されます。
# ソースコード
$data = array('foo' => 123, 'bar' => 456);
$logger->info('hogehoge', array('fugafuga', $data));
# system.logの出力内容
[2024-03-24T11:07:19.700213+00:00] report.INFO: hogehoge ["fugafuga",{"foo":123,"bar":456}] []、
Magentoでログ出力するコードを入れるには。でした。
以上、
Magentoでログ出力するコードを入れるには。でした。
