技術資料

以前、Movable Type のプラグインなどでエラー画面を出力する方法を Movable Type プラグインで実現するエラー画面・ログイン画面の出力方法 で紹介しました。

今回は、MTのシステムログにエラーメッセージなどを出力する方法について紹介します。

システムログにメッセージを出力する

システムログにメッセージを出力するには、MT::App の log メソッドを利用します。

my $app = shift; # MT::App オブジェクトを取得
my $error_message = 'エラーメッセージ'; # エラーメッセージを指定
$app->log({
    message => $error_message,
    level   => MT::Log::ERROR(), # ログレベルを指定
    class    => 'class_name', # ログのクラスを指定
    category => 'category_name', # カテゴリを指定
});

上記のようなコードで、MTのシステムログにデータを追加できます。

ログレベルの指定

ログレベルは、以下の定数を利用して指定します。

MT::Log::DEBUG()

デバッグレベルのログを出力します。

MT::Log::INFO()

情報レベルのログを出力します。

MT::Log::NOTICE()

通知レベルのログを出力します。

MT::Log::WARNING()

警告レベルのログを出力します。

MT::Log::ERROR()

エラーレベルのログを出力します。

MT::Log::SECURITY()

セキュリティレベルのログを出力します。

上記の定数は、MT::Log モジュールで定義されています。

ログのクラスとカテゴリの指定

ログのクラスとカテゴリは、class と category のキーを使って指定します。

クラスは、ログの種類を示すもので、一般的には system や plugin などが使用されます。カテゴリは、ログの詳細な分類を示すもので、プラグイン名や機能名などを指定することができます。

例えば、プラグインのエラーログを出力する場合は、以下のように指定します。

my $app = shift; # MT::App オブジェクトを取得
$app->log({
    message => 'プラグインのエラーメッセージ',
    level   => MT::Log::ERROR(),
    class   => 'plugin',
    category => 'SamplePlugin', # プラグイン名を指定
});

このようにすることで、プラグインのエラーメッセージがシステムログに記録され、後で確認することができます。

システムログの確認

システムログは、Movable Type の管理画面から確認できます。管理画面の「システム」メニューから「ツール」⇒「ログ」を選択すると、ログの一覧が表示されます。

MT8.4系ではデフォルトではログレベルやクラスなどの値が出力されませんが、フィルタ機能を利用して、特定のログレベルやクラスのログだけを一覧することは可能です。

また、システムログはデータベースに保存されているため、直接データベースを参照することでも確認できます。mt_log テーブルにログの情報が保存されています。

まとめ

Movable Type のプラグインなどでシステムログにメッセージを出力する方法について紹介しました。MT::App の log メソッドを利用することで、エラーメッセージや情報メッセージをシステムログに記録できます。

ログレベルやクラス、カテゴリを指定することで、ログの詳細な分類が可能です。システムログは管理画面から確認できるほか、データベースを直接参照することでも確認できます。