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

Copy
1<?php
2
3/**
4 * error_log 関数の基本的な使用方法と、出力が確認できない場合のトラブルシューティングのヒントを示すサンプル。
5 *
6 * error_log 関数は、指定されたメッセージをPHPのシステムロガー、メール、または指定ファイルに送信します。
7 * 出力が確認できない場合、以下の点を確認してください。
8 * 1. PHPの実行プロセスにログファイルへの書き込み権限があるか。
9 * 2. PHPの設定 (php.ini) で `error_log` ディレクティブが正しく設定されているか。
10 * 3. ウェブサーバーのログ設定 (Apacheのerror_log, Nginxのerror.logなど) が正しく、ログファイルがどこにあるか。
11 */
12function demonstrateErrorLogUsage(): void
13{
14    // --- タイプ0: システムログへの出力 (デフォルト) ---
15    // このメッセージは、通常、ウェブサーバーのシステムエラーログに出力されます。
16    // 例: Apacheのerror_logファイル、Nginxのerror.logファイル、またはUnixシステムでのsyslog。
17    // PHPの `error_log` ディレクティブ (php.ini) で出力先が設定されている場合もあります。
18    // 出力が確認できない場合は、ウェブサーバーのログファイルを確認してください。
19    if (error_log("これは、システムエラーログに出力されるテストメッセージです (Type 0)。")) {
20        echo "システムログへのメッセージ出力指示が成功しました (Type 0)。" . PHP_EOL;
21        echo "実際の出力は、ウェブサーバーのログファイル (例: Apacheのerror_log) をご確認ください。" . PHP_EOL;
22    } else {
23        echo "システムログへのメッセージ出力指示が失敗しました (Type 0)。" . PHP_EOL;
24    }
25
26    echo PHP_EOL; // 出力の区切り
27
28    // --- タイプ3: 特定のファイルへの出力 ---
29    // このメッセージは、指定されたファイルに追記されます。
30    // `$logFile` のパスは、このスクリプトと同じディレクトリ内の `custom_errors.log` です。
31    // 出力が確認できない場合、`$logFile` のパスが正しいか、
32    // PHPプロセスにそのファイルまたはディレクトリへの書き込み権限があるか確認してください。
33    // 存在しないディレクトリを指定すると、ファイルは作成されずに失敗します。
34    $logFile = __DIR__ . '/custom_errors.log'; // スクリプトと同じディレクトリにログファイルを作成
35    if (error_log("これは、カスタムファイルに出力されるテストメッセージです (Type 3)。", 3, $logFile)) {
36        echo "カスタムファイル '{$logFile}' へのメッセージ出力指示が成功しました (Type 3)。" . PHP_EOL;
37        echo "ファイルの内容をご確認ください。" . PHP_EOL;
38    } else {
39        echo "カスタムファイル '{$logFile}' へのメッセージ出力指示が失敗しました (Type 3)。" . PHP_EOL;
40        echo "指定されたファイルのパスと、PHPプロセスの書き込み権限を確認してください。" . PHP_EOL;
41    }
42}
43
44// 関数を実行し、ログ出力をデモンストレーションします。
45demonstrateErrorLogUsage();
46
47?>

PHPのerror_log関数は、エラーメッセージやデバッグ情報をシステムロガー、メール、または指定したファイルへ出力するための機能です。主に、ウェブサーバーのログファイルやカスタムログファイルに情報を残す際に利用されます。

この関数は、string $messageで出力したい文字列を指定し、int $message_typeで出力先を決定します。message_typeが0（デフォルト）の場合は、ウェブサーバーのシステムエラーログ（例: ApacheやNginxのerror.log）に出力されます。message_typeが3の場合には、?string $destinationで指定したファイルパスにメッセージが追記されます。?string $additional_headersは、メール送信時（message_type=1）にヘッダーを追加する際に使用しますが、通常は省略可能です。

戻り値はbool型で、メッセージの出力指示が成功した場合はtrue、失敗した場合はfalseを返します。

もしerror_logで出力したメッセージが確認できない場合、以下の点を確認してください。まず、PHPの実行プロセスがログファイルや指定されたディレクトリへの書き込み権限を持っているか確認が必要です。また、php.iniのerror_logディレクティブが正しく設定されているか、ウェブサーバーのログ設定が意図する出力先を示しているかも重要な確認ポイントです。特にmessage_type=3で特定のファイルに出力する場合は、そのファイルのパスとPHPプロセスにファイル作成・追記権限があるかを調べてみてください。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * error_log() 関数の様々な出力先を試すサンプル。
7 *
8 * この関数は、error_log() の第二引数 $message_type を変更することで、
9 * ログの出力先を制御する方法を示します。
10 */
11function demonstrateErrorLogDestinations(): void
12{
13    // ログに出力するメッセージ
14    $logMessage = 'プロセスID ' . getmypid() . ': 処理が完了しました。';
15
16    // --- 出力先パターン 1: PHPのシステムロガー (デフォルトの動作) ---
17    // $message_type を 0 または省略すると、php.ini の 'error_log' ディレクティブで
18    // 指定された場所に出力されます。未設定の場合はWebサーバーのログに出力されることが多いです。
19    error_log('[INFO] ' . $logMessage);
20    echo "1. PHPシステムロガーにログを出力しました。(php.iniやWebサーバーのログを確認)\n";
21
22
23    // --- 出力先パターン 2: 指定のファイルに追記 ---
24    // $message_type に 3 を指定し、第3引数 $destination にファイルパスを指定します。
25    // ファイルが存在しない場合は自動的に作成されます。
26    $logFilePath = __DIR__ . '/application.log';
27    if (error_log(date('[Y-m-d H:i:s] ') . $logMessage . PHP_EOL, 3, $logFilePath)) {
28        echo "2. ファイル '{$logFilePath}' にログを出力しました。\n";
29    } else {
30        echo "2. ファイルへのログ出力に失敗しました。ディレクトリの書き込み権限を確認してください。\n";
31    }
32
33
34    // --- 出力先パターン 3: SAPIハンドラ (Webサーバーのエラーログ / 標準エラー出力) ---
35    // $message_type に 4 を指定すると、SAPI (Server API) のログハンドラに直接送信されます。
36    // Webサーバー経由で実行した場合はサーバーのエラーログ (stderr) に、
37    // コマンドライン (CLI) で実行した場合はコンソールの標準エラー出力に表示されます。
38    error_log('[DEBUG] ' . $logMessage, 4);
39    echo "3. SAPIログハンドラにログを出力しました。(Webサーバーのエラーログやコンソールを確認)\n";
40
41
42    // --- 出力先パターン 4: メールで送信 (注意: 実行にはメールサーバーの設定が必要です) ---
43    // $message_type に 1 を指定し、第3引数に宛先メールアドレスを指定します。
44    // この方法はサーバーのメール送信設定(sendmail等)が正しくないと動作しません。
45    // そのため、以下のコードは通常はコメントアウトして使用します。
46    /*
47    $to = 'sysadmin@example.com';
48    $subject = 'Application Alert';
49    $headers = 'From: webmaster@example.com' . "\r\n" .
50               'Reply-To: webmaster@example.com' . "\r\n" .
51               'X-Mailer: PHP/' . phpversion();
52
53    if (error_log($subject . ': ' . $logMessage, 1, $to, $headers)) {
54        echo "4. メール ({$to}) でのログ送信を試みました。\n";
55    } else {
56        echo "4. メールでのログ送信に失敗しました。\n";
57    }
58    */
59}
60
61// 関数を実行して動作を確認します。
62demonstrateErrorLogDestinations();
63

この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を返すため、処理が正常に行われたかどうかの判定に利用できます。

Copy
1<?php
2
3/**
4 * 配列データをログファイルに記録します。
5 * error_log関数はメッセージとして文字列を期待するため、配列はJSON形式に変換して記録します。
6 *
7 * @param array $data ログに記録する配列データ。
8 * @param string $logFilePath ログを書き込むファイルのパス。
9 * @return bool ログの記録が成功した場合は true、失敗した場合は false。
10 */
11function logArrayDataToFile(array $data, string $logFilePath): bool
12{
13    // 配列を読みやすいJSON形式の文字列に変換します。
14    // JSON_UNESCAPED_UNICODE: マルチバイト文字（日本語など）がエスケープされないようにします。
15    // JSON_PRETTY_PRINT: 構造を見やすくするためにインデントを追加します。
16    $jsonString = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
17
18    // JSONエンコードに失敗した場合はエラーをログに記録し、falseを返します。
19    if ($jsonString === false) {
20        error_log('配列のJSONエンコードに失敗しました。', 0);
21        return false;
22    }
23
24    // error_log関数を使用して、指定されたファイルにメッセージを書き込みます。
25    // 第1引数: 記録するメッセージ（文字列）
26    // 第2引数: メッセージタイプ。3は「指定されたファイルにメッセージを書き込む」ことを意味します。
27    // 第3引数: メッセージタイプが3の場合、書き込み先のファイルパスを指定します。
28    $success = error_log($jsonString, 3, $logFilePath);
29
30    return $success;
31}
32
33// --- 使用例 ---
34
35// ログに記録したい配列データを作成します。
36$userProfile = [
37    'userId' => 101,
38    'username' => 'sample_user_01',
39    'email' => 'user01@example.com',
40    'roles' => ['member', 'viewer'],
41    'isActive' => true,
42    'lastLogin' => date('Y-m-d H:i:s'),
43    'preferences' => [
44        'theme' => 'light',
45        'notifications' => true
46    ]
47];
48
49// ログファイルのパスを定義します。現在のスクリプトがあるディレクトリにファイルを作成します。
50$logFileName = 'application_debug.log';
51$logFilePath = __DIR__ . '/' . $logFileName;
52
53// 関数を呼び出して配列データをログに記録します。
54if (logArrayDataToFile($userProfile, $logFilePath)) {
55    echo "配列データが以下のファイルに正常に記録されました: " . $logFilePath . PHP_EOL;
56    echo "ファイルの内容を確認してください。" . PHP_EOL;
57} else {
58    echo "配列データのログ記録に失敗しました。" . PHP_EOL;
59}
60
61// 補足: デフォルトのログ出力先 (php.iniで設定された error_log) に記録する場合の例
62// $message_type = 0 は、PHPのシステムロガー（Webサーバーのエラーログやsyslogなど）に出力されます。
63$eventData = [
64    'event' => 'page_visit',
65    'page' => '/products/item123',
66    'timestamp' => date('Y-m-d H:i:s')
67];
68$eventJson = json_encode($eventData, JSON_UNESCAPED_UNICODE);
69if ($eventJson !== false) {
70    error_log("イベント情報: " . $eventJson, 0);
71    echo "イベント情報がデフォルトのログ出力先にも記録されました (通常はWebサーバーのエラーログなど)。" . PHP_EOL;
72}
73
74?>

PHP 8のerror_log関数は、プログラムの実行中に発生したエラーやデバッグ情報を、指定されたログ出力先へ記録するために利用されます。

この関数の第1引数 $message には、ログに記録したい文字列を指定します。error_log関数は文字列データのみを受け付けるため、サンプルコードのように配列データを記録したい場合は、json_encode関数を使ってJSON形式の文字列に変換する必要があります。この際、JSON_UNESCAPED_UNICODEオプションで日本語を正しく表示し、JSON_PRETTY_PRINTオプションで整形すると、ログが見やすくなります。

第2引数 $message_type は、ログの出力先を指定する整数値です。0 を指定すると、PHPの設定（php.iniのerror_logディレクティブ）に従い、通常はWebサーバーのエラーログやシステムログに出力されます。一方、3 を指定すると、第3引数 $destination で指定されたファイルパスに直接メッセージが書き込まれます。

第3引数 $destination は、$message_typeが3の場合に、ログを書き込むファイルのパスを指定します。

戻り値はbool型で、ログの記録が成功した場合はtrue、失敗した場合はfalseを返します。この関数を活用することで、システムの動作状況を効率的に記録し、問題発生時の調査やデバッグ作業に役立てることができます。