萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 寫入系統 Syslog 完整實作:Linux 配置與程式碼整合

將應用程式日誌寫入系統 Syslog,能統一由 `rsyslog`/`syslog-ng` 管理輪轉、集中收集、異常告警,是生產環境運維的最佳實踐。本文完整說明 Linux Syslog 設施配置、PHP `syslog()` 介面使用與結構化日誌建議。

Linux Syslog 設施與等級

Facility (設施)常數用途
USERLOG_USER一般使用者程式 (預設)
LOCAL0 ~ LOCAL7LOG_LOCAL0 ~ LOG_LOCAL7自訂應用程式 (推薦)
DAEMONLOG_DAEMON系統守護程式
AUTH / AUTHPRIVLOG_AUTH / LOG_AUTHPRIV認證/授權相關

Priority (優先級/等級) - 由高到低

LOG_EMERG   (0)  系統不可用
LOG_ALERT   (1)  需立即處理
LOG_CRIT    (2)  嚴重錯誤
LOG_ERR     (3)  錯誤
LOG_WARNING (4)  警告
LOG_NOTICE  (5)  正常但重要事件
LOG_INFO    (6)  資訊
LOG_DEBUG   (7)  除錯資訊

rsyslog 配置範例:專屬應用日誌檔

編輯 `/etc/rsyslog.d/50-myapp.conf`:

# 使用 LOCAL4 設施,info 以上等級寫入專屬檔案
local4.info    -/var/log/myapp/app.log

# debug 等級單獨存放 (除錯用)
local4.debug   -/var/log/myapp/debug.log

# 錯誤以上同步寫入 (減少資料遺失)
local4.err     /var/log/myapp/error.log

建立目錄與權限:

sudo mkdir -p /var/log/myapp
sudo chown syslog:adm /var/log/myapp
sudo chmod 750 /var/log/myapp
sudo systemctl restart rsyslog

PHP 程式碼整合

<?php
/**
 * 系統日誌記錄器
 */
class SyslogLogger {
    private $ident;
    private $facility;

    public function __construct(string $ident = 'MyApp', int $facility = LOG_LOCAL4) {
        $this->ident   = $ident;
        $this->facility = $facility;
        // 建立連線,LOG_PID 包含 PID,LOG_PERROR 同時輸出到 stderr (CLI 除錯用)
        openlog($this->ident, LOG_PID | LOG_PERROR, $this->facility);
    }

    public function __destruct() {
        closelog();
    }

    public function log(int $priority, string $message, array $context = []): void {
        // 簡單結構化:JSON 編碼 context
        $ctx = $context ? ' ' . json_encode($context, JSON_UNESCAPED_UNICODE) : '';
        syslog($priority, $message . $ctx);
    }

    // 便利方法
    public function emergency($msg, $ctx = []) { $this->log(LOG_EMERG,   $msg, $ctx); }
    public function alert($msg, $ctx = [])    { $this->log(LOG_ALERT,   $msg, $ctx); }
    public function critical($msg, $ctx = []) { $this->log(LOG_CRIT,    $msg, $ctx); }
    public function error($msg, $ctx = [])    { $this->log(LOG_ERR,     $msg, $ctx); }
    public function warning($msg, $ctx = [])  { $this->log(LOG_WARNING, $msg, $ctx); }
    public function notice($msg, $ctx = [])   { $this->log(LOG_NOTICE,  $msg, $ctx); }
    public function info($msg, $ctx = [])     { $this->log(LOG_INFO,    $msg, $ctx); }
    public function debug($msg, $ctx = [])    { $this->log(LOG_DEBUG,   $msg, $ctx); }
}

// 使用範例
$logger = new SyslogLogger('OrderService', LOG_LOCAL4);
$logger->info('訂單建立', ['order_id' => 12345, 'user_id' => 1001]);
$logger->error('付款失敗', ['order_id' => 12345, 'gateway' => 'stripe', 'error' => 'card_declined']);

// CLI 測試
// php -r 'require "logger.php"; $l=new SyslogLogger("Test"); $l->info("Hello");'

驗證日誌寫入

# 即時追蹤
tail -f /var/log/myapp/app.log

# 篩選特定訂單
grep "order_id.*12345" /var/log/myapp/app.log

# 使用 logger 指令手動測試設施
logger -p local4.info "Manual test message"

進階:結構化日誌與 ELK 整合

  • 訊息格式統一為 JSON:`syslog(LOG_INFO, json_encode(['@timestamp'=>date('c'), 'level'=>'info', 'msg'=>'...', 'ctx'=>[...]]))`
  • rsyslog 配置 `action(type="omfile" template="jsonTemplate")` 或使用 `omelasticsearch` 直接推送 Elasticsearch。
  • Logstash/Filebeat 收集 `/var/log/myapp/*.log`,解析 JSON 欄位建立儀表板。

Windows 環境注意

Windows PHP `syslog()` 寫入 Event Log (應用程式日誌),Facility 僅支援 `LOG_USER`。跨平台專案建議封裝介面,Windows 下改寫檔案/Monolog,Linux 使用 Syslog。

最佳實務總結

  1. 選擇專用 `LOCAL0-7` 設施,避免污染系統日誌。
  2. 配置 `rsyslog` 分檔、輪轉 (`logrotate`)、遠端轉發。
  3. PHP 封裝 Logger 類別,統一錯誤等級、結構化 Context。
  4. 生產環境關閉 `LOG_PERROR`,避免污染標準錯誤輸出。
  5. 嚴禁記錄敏感資料 (密碼、Token、信用卡),Context 需過濾脫敏。

Syslog 是「寫入即忘」的可靠日誌管道,配合集中式日誌平台,讓觀測能力從「查檔案」進化為「查儀表板、設告警」。

copyright © 萬盛學電腦網 all rights reserved