/think-monolog

ThinkPHP3.2集成monolog

Primary LanguagePHP

介绍

ThinkPHP 3.2 集成 monolog

monolog简介

monolog是 Laravel,Symfony,Silex 默认集成的日志库, 同时大量其他框架提供了集成扩展.

它是最流行的 php log库, 自带超多handler, 长期维护, 稳定更新.

它支持以各种方式记录日志: 记录到文件,mail,nosql,mail,irc,firephp,elasticsearch服务器....

注意:

由于 SHOW_PAGE_TRACE 设为 true 以后, TP不再将trace数据记录到log.

也就是说, 在不修改TP源码的情况下想用monolog收集trace数据, TRACE BAR 和 monolog 你只能二选一.

而本人扩展框架的原则是, 为了不影响升级框架, 对框架的功能扩展绝不修改源码.

因此, 集成monolog后, 为了能收集到trace数据, 在内部已将 SHOW_PAGE_TRACE 设为了 false.

安装使用

composer中文文档

安装

composer requrie snowair/think-monolog:dev-master

使用

安装完成后, 就可以立即在应用的代码中这样使用 monolog:

\Snowair\Think\Logger::debug('这是一条debug日志');
\Snowair\Think\Logger::info('这是一条info日志');
\Snowair\Think\Logger::warn('这是一条warn日志');
\Snowair\Think\Logger::error('这是一条error日志');

自定义

默认行为

think-monolog 默认向monolog注册了 StreamHandler, 日志级别为debug, 这就是为什么安装后可以直接使用的原因.

既然我们用monolog, 肯定是为了使用其提供的丰富的 handlers. 而不是为了仅仅在文件中记录日志. 下面将通过一个实例说明如何自定义 monolog

示例:

自己建一个行为类, 在这个行为类中完成 monolog 实例的 handlers 和 processors 的添加.

创建 Common/Behavior/MonologBehavior.class.php :

<?php
namespace Common\Behavior;

use Think\Behavior;
use Snowair\Think\Logger;
use Monolog\Handler\MongoDBHandler;

class MonologBehavior extends Behavior
{

    public function run( &$params )
    {
        /**
         think-monolog 默认注册的StreamHandler的日志级别为 debug. 
         如果你想改变它的级别或者不想使用StreamHandler, 就需要先取出这个handler.
         假设,我们现在的在生产环境下的日志需求是这样:
            1. 只想在本地文件中记录Error以上级别的日志供常规检查
            2. info 以上的日志向发到外部的 MongoDb 数据库中,供日志监控和分析
            3. 不记录任何debug信息.
        */
        
        $logger = Logger::getLogger();
        $stream_handler = $logger->popHandler();  // 取出 StreamHandler 对象
        $stream_handler->setLevel(Logger::ERROR); // 重设其日志级别
        $logger->pushHandler($stream_handler);    // 注册修改后的StreamHandler 对象
        
        $mongodb = new MongoDBHandler(new \Mongo("mongodb://***.***.***.***:27017"), "logs", "prod", Logger::INFO);
        $logger->pushHandler($mongodb); // 文件
    }
}

在Common/Conf/tags.php 增加一个app_begin行为:

return array(
    'app_begin' =>array(
        'Common\Behavior\MonologBehavior'
        ),
);

接管TP默认trace行为

默认情况, think-monolog 并不会接管ThinkPHP的 trace 逻辑. 二者互不影响.

如果你希望 think-monolog 接管ThinkPHP的trace逻辑, 只需要将 LOG_TYPE 配置设为monolog. 这样配置以后, SHOW_PAGE_TRACE 将强制关闭, 以便monolog完全接管日志工作.

现在, 你可以像过去一样使用TP的 trace 函数记录日志, 所有的trace数据依然是以一条日志的形式在请求结束时被monolog记录.

如果你希望单独记录一些日志, 依然需要使用 monolog:

\Snowair\Think\Logger::debug('这是一条debug日志');
\Snowair\Think\Logger::info('这是一条info日志');
\Snowair\Think\Logger::warn('这是一条warn日志');
\Snowair\Think\Logger::error('这是一条error日志');

注意:

handler的日志级别设置仅对直接通过 monolog 添加的日志有效. 无论handler的日志级别如何, trace 日志一定会被无条件记录.

因此, 接管后不建议使用trace函数记录日志.