日志

日志可以快速幫助開發(fā)者快速定位問題的根源、追蹤程序執(zhí)行的過程、追蹤數(shù)據(jù)變化、數(shù)據(jù)統(tǒng)計和性能分析等。

配置說明

EasySwoole 在 3.4.4 版本中優(yōu)化了框架默認的日志處理機制，允許用戶更加方便地去自定義配置日志處理，可以直接在配置文件 (dev.php/produce.php) 中進行配置。(以后版本也將兼容以下配置特性)

配置包括以下幾方面：

• 設置記錄日志文件時日志文件存放目錄 (dir)，用戶可以自己設置日志存放目錄(但是一定要保證日志有寫入權限)，配置值為 路徑，默認為 框架根目錄的 Log 目錄。
• 設置記錄日志時的日志最低等級 (level)，等級配置值默認為 \EasySwoole\Log\LoggerInterface::LOG_LEVEL_DEBUG，等級值支持 \EasySwoole\Log\LoggerInterface::LOG_LEVEL_DEBUG (0級)、\EasySwoole\Log\LoggerInterface::LOG_LEVEL_INFO (1級)、\EasySwoole\Log\LoggerInterface::LOG_LEVEL_NOTICE (2級)、\EasySwoole\Log\LoggerInterface::LOG_LEVEL_WARNING (3級)、\EasySwoole\Log\LoggerInterface::LOG_LEVEL_ERROR (4級)。例如當我們在配置文件中把日志等級設置為 \EasySwoole\Log\LoggerInterface::LOG_LEVEL_INFO (1級) 時，就不會把我們在框架中調(diào)用打印小于這個等級的日志記錄記錄到日志文件中 (比如 LOG_LEVEL_DEBUG (0級) 就不會被記錄到日志當中了，也不會顯示在控制臺了)。
• 設置日志處理器 handler (handler)，默認使用框架內(nèi)置 handler，用戶可以自定義日志類實現(xiàn) \EasySwoole\Log\LoggerInterface 接口，來處理記錄日志。配置值為 自定義處理類名，默認為 \EasySwoole\Log\Logger。具體自定義實現(xiàn)日志處理器可看下文。
• 設置記錄日志到日志文件時是否在控制臺打印日志 (logConsole)。配置值為 boolean 值，默認為 true，即開啟。
• 設置是否開啟在控制臺打印日志 (displayConsole)。配置值為 boolean 值，默認為 true，即開啟。
• 設置打印日志時忽略哪些分類的日志不進行記錄 (ignoreCategory) 。配置值為 array 類型值，默認為 null (即不忽略任何分類的日志，任何分類的日志都進行在控制臺顯示打印并記錄到文件)，配置忽略分類值支持 debug、info、notice、warning、error 作為配置值 array 中的可選值。例如：設置為 ['debug', 'notice'] 時，即當我們在框架中使用下面列舉的使用日志的方法時，調(diào)用 debug 和 notice 方法記錄日志時，不會把 debug 和 notice 分類的日志在控制臺顯示，也不會記錄到日志文件中。

下面為配置文件中配置示例：

<?php

use EasySwoole\Log\LoggerInterface;

return [
    // ... 這里省略
    'MAIN_SERVER' => [
        // ... 這里省略
    ],
    "LOG" => [
        // 設置記錄日志文件時日志文件存放目錄
        'dir' => null,
        // 設置記錄日志時的日志最低等級，低于此等級的日志不進行記錄和顯示
        'level' => LoggerInterface::LOG_LEVEL_DEBUG,
        // 設置日志處理器 `handler` (handler)
        'handler' => null,
        // 設置開啟在記錄日志到日志文件時在控制臺打印日志
        'logConsole' => true,
        // 設置開啟在控制臺顯示日志
        'displayConsole'=>true,
        // 設置打印日志時忽略哪些分類的日志不進行記錄
        'ignoreCategory' => []
    ],
    // ... 這里省略
];

注意：在 EasySwoole 3.4.3 版本中，僅支持對上述 dir、level、handler 的配置。而在 3.4.2 之前版本中，僅支持對上述 dir 的配置。

日志使用

以下方法可以在框架的 boostrap 事件之后的任意位置進行調(diào)用。調(diào)用之前請先看下文注意事項。

log 記錄顯示日志

// 打印和記錄 `DEBUG` 等級、`debug` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->log('record level:DEBUG-category:debug log info',\EasySwoole\Log\LoggerInterface::LOG_LEVEL_DEBUG,'debug');
### [舊版本說明] 注意：當找不到 `\EasySwoole\Log\LoggerInterface::LOG_LEVEL_DEBUG` 常量，請查看是否為 `\EasySwoole\EasySwoole\Logger::LOG_LEVEL_INFO` 

// 打印和記錄 `INFO` 等級、`info` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->log('record level:INFO-category:info log info',\EasySwoole\Log\LoggerInterface::LOG_LEVEL_INFO,'info');

// 打印和記錄 `NOTICE` 等級、`notice` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->log('record level:NOTICE-category:notice log info',\EasySwoole\Log\LoggerInterface::LOG_LEVEL_NOTICE,'notice');

// 打印和記錄 `WARNING` 等級、`warning` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->log('record level:WARNING-category:warning log info',\EasySwoole\Log\LoggerInterface::LOG_LEVEL_WARNING,'warning');

// 打印和記錄 `ERROR` 等級、`error` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->log('record level:ERROR-category:error log info',\EasySwoole\Log\LoggerInterface::LOG_LEVEL_ERROR,'error');

運行結(jié)果：在控制臺和日志文件 Log\log_XxxxXx.log 中均可看到如下結(jié)果：

// 格式說明: [記錄日志時間][分類][等級]:[日志內(nèi)容]
[2021-03-18 22:52:09][debug][debug]:[record level:DEBUG-category:debug log info]
[2021-03-18 22:52:09][info][info]:[record level:INFO-category:info log info]
[2021-03-18 22:52:09][notice][notice]:[record level:NOTICE-category:notice log info]
[2021-03-18 22:52:09][warning][warning]:[record level:WARNING-category:warning log info]
[2021-03-18 22:52:09][error][error]:[record level:ERROR-category:error log info]

info 日志

// 打印和記錄 `INFO` 等級、`info` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->info('record level:INFO-category:info log info');

waring 日志

// 打印和記錄 `WANING` 等級、`waring` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->waring('record level:WANING-category:waring log info');

console 日志

// 只在控制臺打印 `INFO` 等級、`debug` 分類的日志 (不記錄日志文件)
\EasySwoole\EasySwoole\Logger::getInstance()->console('console', \EasySwoole\Log\LoggerInterface::LOG_LEVEL_INFO, 'debug');

notice 日志

// 打印和記錄 `NOTICE` 等級、`notice` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->notice('record level:NOTICE-category:notice log info');

error 日志

// 打印和記錄 `ERROR` 等級、`error` 分類的日志
\EasySwoole\EasySwoole\Logger::getInstance()->error('record level:ERROR-category:error log info');

event 日志寫入后執(zhí)行回調(diào)

使用 event 時，請先注冊 Event。

// 日志寫入之后執(zhí)行
\EasySwoole\EasySwoole\Logger::getInstance()->onLog()->set('myHook', function ($msg, $logLevel, $category) {
    // 增加日志寫入之后的回調(diào)函數(shù)
});

自定義日志處理器

需要實現(xiàn) EasySwoole\Log\LoggerInterface 即可：

自定義示例如下，新建 App\Log\LogHandler.php 文件，編輯內(nèi)容如下：

<?php

namespace App\Log;

use EasySwoole\Log\LoggerInterface;

class LogHandler implements LoggerInterface
{

    private $logDir;

    function __construct(string $logDir = null)
    {
        if (empty($logDir)) {
            $logDir = getcwd();
        }
        $this->logDir = $logDir;
    }

    function log(?string $msg, int $logLevel = self::LOG_LEVEL_INFO, string $category = 'debug'): string
    {
        $date = date('Y-m-d H:i:s');
        $levelStr = $this->levelMap($logLevel);
        $filePath = $this->logDir . "/log_{$category}.log";
        $str = "自定義日志:[{$date}][{$category}][{$levelStr}] : [{$msg}]\n";
        file_put_contents($filePath, "{$str}", FILE_APPEND | LOCK_EX);
        return $str;
    }

    function console(?string $msg, int $logLevel = self::LOG_LEVEL_INFO, string $category = 'console')
    {
        $date = date('Y-m-d H:i:s');
        $levelStr = $this->levelMap($logLevel);
        $temp = "自定義日志:[{$date}][{$category}][{$levelStr}]:[{$msg}]\n";
        fwrite(STDOUT, $temp);
    }

    private function levelMap(int $level)
    {
        switch ($level) {
            case self::LOG_LEVEL_INFO:
                return 'info';
            case self::LOG_LEVEL_NOTICE:
                return 'notice';
            case self::LOG_LEVEL_WARNING:
                return 'warning';
            case self::LOG_LEVEL_ERROR:
                return 'error';
            default:
                return 'unknown';
        }
    }
}

注冊自定義日志處理器

(EasySwoole 3.4.4 及以上版本可使用) 方法1. 在配置文件 (dev.php / produce.php)中注冊自定義日志處理器

<?php

use EasySwoole\Log\LoggerInterface;

return [
    // ... 這里省略
    'MAIN_SERVER' => [
        // ... 這里省略
    ],
    "LOG" => [
        'dir' => null,
        'level' => LoggerInterface::LOG_LEVEL_DEBUG,
        // 注冊日志處理器 `handler` (handler)
        'handler' =>  new \App\Log\LogHandler(),
        'logConsole' => true,
        'displayConsole'=>true,
        'ignoreCategory' => []
    ],
    // ... 這里省略
];

(EasySwoole 3.4.x+ 版本可使用) 方法2. 在 initialize 事件 中注冊自定義 logger 處理器

注冊示例代碼如下：

<?php

namespace EasySwoole\EasySwoole;

use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\EasySwoole\Swoole\EventRegister;

class EasySwooleEvent implements Event
{
    public static function initialize()
    {
        date_default_timezone_set('Asia/Shanghai');

        // 注冊自定義 `logger` 處理器
        \EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::LOGGER_HANDLER, new \App\Log\LogHandler());

        // 或使用如下方式進行注冊自定義 `logger` 處理器
        // \EasySwoole\EasySwoole\Logger::getInstance(new \App\Log\LogHandler());
    }

    public static function mainServerCreate(EventRegister $register)
    {

    }
}

日志中心

通常在一些情況下，會把數(shù)據(jù)往日志中心推送進行數(shù)據(jù)分析，在 onLog 回調(diào)，把日志信息，推送到日志中心即可。