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

<?php

/**
 * PHP openlog, syslog, closelog Example
 *
 * このスクリプトは、PHPのsyslog関連関数を使って
 * システムロガー (syslog) にメッセージを送信する方法を示します。
 *
 * システムロガーへの接続を開き、異なる優先度でいくつかのメッセージを送信し、
 * その後接続を閉じます。
 *
 * システムエンジニアにとって、これはアプリケーションのイベントを標準化された方法でログに記録し、
 * ログ分析ツールで管理するのに役立ちます。
 */

// 1. システムロガーへの接続を開きます。
//    - 'MyPHPScript': このプレフィックスがすべてのメッセージの前に付加されます。
//    - LOG_PID | LOG_PERROR:
//      - LOG_PID: 各メッセージに現在のプロセスIDを含めます。
//      - LOG_PERROR: エラーが発生した場合、メッセージを標準エラー出力にも出力します。
//    - LOG_LOCAL0: ログ記録にlocal0ファシリティを使用します。これはカスタムアプリケーションでよく使用され、
//      syslogデーモンの設定で構成できます。
if (openlog('MyPHPScript', LOG_PID | LOG_PERROR, LOG_LOCAL0)) {
    // 2. syslog() を使用してシステムロガーにメッセージを送信します。

    // 情報メッセージをログに記録します。
    syslog(LOG_INFO, 'スクリプトが正常に開始されました。');

    // 警告を引き起こす可能性のあるイベントをシミュレートします。
    $configFileExists = false; // デモンストレーション用
    if (!$configFileExists) {
        syslog(LOG_WARNING, '設定ファイルが見つかりません。デフォルト設定を使用します。');
    }

    // エラー条件をシミュレートします。
    $databaseConnectionSuccessful = false; // デモンストレーション用
    if (!$databaseConnectionSuccessful) {
        syslog(LOG_ERR, 'データベースへの接続に失敗しました。スクリプトを終了します。');
        // 実際のアプリケーションでは、ここでスクリプトを終了したり、例外をスローしたりするかもしれません。
    }

    // 3. システムロガーへの接続を閉じます。
    closelog();

    echo "メッセージがsyslogに送信されました。システムのログファイル (例: /var/log/syslog や journalctl) を確認してください。\n";
} else {
    echo "syslog接続を開くのに失敗しました。\n";
}

?>

PHPのopenlog関数は、アプリケーションがシステムロガー（syslog）へログメッセージを送信するための接続を開きます。これにより、イベントやエラー情報を標準的なシステムログに記録する際に利用します。

第一引数$prefixは、ログメッセージの前に付加されるプログラム名です。 第二引数$flagsは、LOG_PID（プロセスIDを含める）やLOG_PERROR（エラー時に標準エラー出力にも出す）といったログ出力オプション（整数）を設定し、複数組み合わせも可能です。 第三引数$facilityは、LOG_LOCAL0のようなログカテゴリ（整数）を指定し、syslogデーモンの設定と連携します。

関数は、接続開始成功時にtrueを、失敗時にfalseを戻り値として返します。

サンプルコードでは、openlogで接続を開き、syslog()関数を使って情報、警告、エラーメッセージを送信し、closelog()関数で接続を閉じています。PHPログをsyslog形式で出力することは、システム監視やトラブルシューティングに大変役立ちます。