いっしー@Webエンジニア
トップページポートフォリオプログラミング言語ITニュースIT用語辞典ブログ

【PHP8.x】error_log関数の使い方

作成日: 更新日:

error_log関数は、プログラムの実行中に発生したエラーメッセージやデバッグ情報、またはその他の任意のメッセージをログファイルや指定された宛先に記録する関数です。この関数は、アプリケーションの動作を監視したり、問題の原因を特定したりする際に非常に重要な役割を果たします。

システム開発や運用において、プログラムが意図しない動作をしたり、エラーが発生したりすることは少なくありません。そのような場合、何が起こったのか、どのような状況でエラーが発生したのかを知るための手がかりが必要となります。error_log関数は、このような情報をテキストファイルやシステムログなどの記録媒体に残すことで、開発者や運用担当者が問題解決に役立てるための情報を提供します。

具体的には、任意の文字列メッセージを指定し、PHPが標準で出力するエラーログに記録したり、特定のファイルに直接書き込んだり、あるいは管理者へメールで通知したりするといった様々な方法でログを記録できます。例えば、ある処理が正常に完了したかどうかを確認したい場合や、予期せぬ値が変数に代入された際にその値を出力したい場合などに利用することで、プログラムの内部状態を外部から確認することが可能になります。

この機能は、開発段階でのデバッグ作業だけでなく、実際に稼働している本番環境でのエラー監視やシステムの状態把握にも不可欠です。適切なログメッセージを記録することで、システムの健全性を維持し、万が一の障害発生時にも迅速な対応を可能にするための重要な基盤となります。error_log関数は、PHPアプリケーションの信頼性と保守性を高めるための基本的なツールの一つと言えます。

基本的な使い方

構文(syntax)

<?php
error_log("ログに記録するメッセージ", 3, "/var/log/php_application.log");

引数(parameters)

string $message, int $message_type = 0, ?string $destination = null, ?string $additional_headers = null

  • string $message: 記録したいエラーメッセージを指定する文字列
  • int $message_type = 0: エラーメッセージの種類を指定する整数。デフォルトは0で、通常のメッセージとして扱われます。
  • ?string $destination = null: メッセージの送信先を指定する文字列。nullの場合は、PHPの設定ファイル(php.ini)で指定されたログファイルや、エラーログ機能が有効になっている場合はサーバーのエラーログに記録されます。
  • ?string $additional_headers = null: メッセージをメールで送信する場合に使用する追加のヘッダーを指定する文字列。

戻り値(return)

bool

指定されたメッセージの送信に成功した場合は true を、失敗した場合は false を返します。

サンプルコード

PHP error_log 出力先を制御する

<?php

declare(strict_types=1);

/**
 * error_log() 関数の様々な出力先を試すサンプル。
 *
 * この関数は、error_log() の第二引数 $message_type を変更することで、
 * ログの出力先を制御する方法を示します。
 */
function demonstrateErrorLogDestinations(): void
{
    // ログに出力するメッセージ
    $logMessage = 'プロセスID ' . getmypid() . ': 処理が完了しました。';

    // --- 出力先パターン 1: PHPのシステムロガー (デフォルトの動作) ---
    // $message_type を 0 または省略すると、php.ini の 'error_log' ディレクティブで
    // 指定された場所に出力されます。未設定の場合はWebサーバーのログに出力されることが多いです。
    error_log('[INFO] ' . $logMessage);
    echo "1. PHPシステムロガーにログを出力しました。(php.iniやWebサーバーのログを確認)\n";


    // --- 出力先パターン 2: 指定のファイルに追記 ---
    // $message_type に 3 を指定し、第3引数 $destination にファイルパスを指定します。
    // ファイルが存在しない場合は自動的に作成されます。
    $logFilePath = __DIR__ . '/application.log';
    if (error_log(date('[Y-m-d H:i:s] ') . $logMessage . PHP_EOL, 3, $logFilePath)) {
        echo "2. ファイル '{$logFilePath}' にログを出力しました。\n";
    } else {
        echo "2. ファイルへのログ出力に失敗しました。ディレクトリの書き込み権限を確認してください。\n";
    }


    // --- 出力先パターン 3: SAPIハンドラ (Webサーバーのエラーログ / 標準エラー出力) ---
    // $message_type に 4 を指定すると、SAPI (Server API) のログハンドラに直接送信されます。
    // Webサーバー経由で実行した場合はサーバーのエラーログ (stderr) に、
    // コマンドライン (CLI) で実行した場合はコンソールの標準エラー出力に表示されます。
    error_log('[DEBUG] ' . $logMessage, 4);
    echo "3. SAPIログハンドラにログを出力しました。(Webサーバーのエラーログやコンソールを確認)\n";


    // --- 出力先パターン 4: メールで送信 (注意: 実行にはメールサーバーの設定が必要です) ---
    // $message_type に 1 を指定し、第3引数に宛先メールアドレスを指定します。
    // この方法はサーバーのメール送信設定(sendmail等)が正しくないと動作しません。
    // そのため、以下のコードは通常はコメントアウトして使用します。
    /*
    $to = 'sysadmin@example.com';
    $subject = 'Application Alert';
    $headers = 'From: webmaster@example.com' . "\r\n" .
               'Reply-To: webmaster@example.com' . "\r\n" .
               'X-Mailer: PHP/' . phpversion();

    if (error_log($subject . ': ' . $logMessage, 1, $to, $headers)) {
        echo "4. メール ({$to}) でのログ送信を試みました。\n";
    } else {
        echo "4. メールでのログ送信に失敗しました。\n";
    }
    */
}

// 関数を実行して動作を確認します。
demonstrateErrorLogDestinations();

このPHPサンプルコードは、error_log()関数を使って、メッセージを様々な場所へ出力する方法を示しています。この関数は、プログラムの動作状況やエラー情報をログとして記録する際に使用します。

error_log()関数の最も重要な引数は、第1引数の$message（出力したい文字列）と、第2引数の$message_type（出力先を指定する整数）です。この$message_typeの値を変えることで、ログの出力先を制御します。

サンプルコードでは、まず第2引数を省略した場合のデフォルトの動作を確認します。この場合、PHPの設定ファイル（php.ini）で指定されたシステムログに出力されます。次に、$message_typeに3を指定し、第3引数$destinationにファイルパスを渡すことで、特定のファイルにログを追記しています。さらに、4を指定すると、Webサーバーのエラーログやコマンドラインのコンソール（標準エラー出力）に直接出力できます。

この関数は、ログの出力に成功するとtrueを、失敗するとfalseを返すため、処理が正常に行われたかどうかの判定に利用できます。

error_log関数は、第二引数 $message_type によってログの出力先が変化します。デフォルトの動作ではphp.iniのerror_log設定やWebサーバーのログに出力されます。ファイルに直接出力する際は（$message_type = 3）、PHP実行ユーザーが指定ディレクトリへの書き込み権限を持つか必ず確認してください。権限不足で失敗する場合があります。$message_type = 4はWebサーバーのエラーログやCLI実行時の標準エラー出力に送られます。メール送信（$message_type = 1）はサーバーにメール送信機能が正しく設定されていないと機能せず、セキュリティや管理の観点から一般的なエラー通知方法としては推奨されません。利用目的に応じて適切な出力先を選び、それぞれのログの確認方法を把握することが重要です。

【PHP8.x】error_log関数の使い方 | いっしー@Webエンジニア