PHP Yii 프레임워크의 로깅 기능 정보

이 글에서는 주로 PHP Yii 프레임워크의 로그를 소개합니다. 로그 분석은 일상적인 웹사이트 유지 관리의 기초입니다. Yii는 비교적 강력한 로그 기능을 제공하므로 필요한 친구는 이를 참조할 수 있습니다.

Yii 페이지 수준 로그
Main.php에 로그 섹션을 추가하세요.
페이지 로그 배열이 아래에 표시됩니다( 'class'=>'CWebLogRoute', 'levels'=>'trace', //레벨은 추적 '범주'입니다). '=>' system.db.*' //데이터베이스 연결, 데이터베이스 실행 문을 포함하여 데이터베이스에 대한 정보만 표시),
전체 목록은 다음과 같습니다.

'log'=>array(
    'class'=>'CLogRouter',
    'routes'=>array(
      array(
        'class'=>'CFileLogRoute',
        'levels'=>'error, warning',

      ),
              // 下面显示页面日志 
              array( 
               'class'=>'CWebLogRoute', 
               'levels'=>'trace',  //级别为trace 
               'categories'=>'system.db.*' //只显示关于数据库信息,包括数据库连接,数据库执行语句 
              ), 
      // uncomment the following to show log messages on web pages
      /*
      array(
        'class'=>'CWebLogRoute',
      ),
      */
    ),
  ),

제공되는 로그 구성 요소 확장 Yii2

 <?php

/**
 * author   : forecho <caizhenghai@gmail.com>
 * createTime : 2015/12/22 18:13
 * description:
 */
namespace common\components;

use Yii;
use yii\helpers\FileHelper;

class FileTarget extends \yii\log\FileTarget
{
  /**
   * @var bool 是否启用日志前缀 (@app/runtime/logs/error/20151223_app.log)
   */
  public $enableDatePrefix = false;

  /**
   * @var bool 启用日志等级目录
   */
  public $enableCategoryDir = false;

  private $_logFilePath = &#39;&#39;;

  public function init()
  {
    if ($this->logFile === null) {
      $this->logFile = Yii::$app->getRuntimePath() . &#39;/logs/app.log&#39;;
    } else {
      $this->logFile = Yii::getAlias($this->logFile);
    }
    $this->_logFilePath = dirname($this->logFile);

    // 启用日志前缀
    if ($this->enableDatePrefix) {
      $filename = basename($this->logFile);
      $this->logFile = $this->_logFilePath . &#39;/&#39; . date(&#39;Ymd&#39;) . &#39;_&#39; . $filename;
    }

    if (!is_dir($this->_logFilePath)) {
      FileHelper::createDirectory($this->_logFilePath, $this->dirMode, true);
    }

    if ($this->maxLogFiles < 1) {
      $this->maxLogFiles = 1;
    }
    if ($this->maxFileSize < 1) {
      $this->maxFileSize = 1;
    }

  }
}

구성 파일에서 다음과 같이 사용됩니다.

'components' => [
  'log' => [
    'traceLevel' => YII_DEBUG ? 3 : 0,
    'targets' => [
      /**
       * 错误级别日志：当某些需要立马解决的致命问题发生的时候，调用此方法记录相关信息。
       * 使用方法：Yii::error()
       */
      [
        'class' => 'common\components\FileTarget',
        // 日志等级
        'levels' => ['error'],
        // 被收集记录的额外数据
        'logVars' => ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION','_SERVER'],
        // 指定日志保存的文件名
        'logFile' => '@app/runtime/logs/error/app.log',
        // 是否开启日志 (@app/runtime/logs/error/20151223_app.log)
        'enableDatePrefix' => true,
        'maxFileSize' => 1024 * 1,
        'maxLogFiles' => 100,
      ],
      /**
       * 警告级别日志：当某些期望之外的事情发生的时候，使用该方法。
       * 使用方法：Yii::warning()
       */
      [
        'class' => 'common\components\FileTarget',
        // 日志等级
        'levels' => ['warning'],
        // 被收集记录的额外数据
        'logVars' => ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION','_SERVER'],
        // 指定日志保存的文件名
        'logFile' => '@app/runtime/logs/warning/app.log',
        // 是否开启日志 (@app/runtime/logs/warning/20151223_app.log)
        'enableDatePrefix' => true,
        'maxFileSize' => 1024 * 1,
        'maxLogFiles' => 100,
      ],
      /**
       * info 级别日志：在某些位置记录一些比较有用的信息的时候使用。
       * 使用方法：Yii::info()
       */
      [
        'class' => 'common\components\FileTarget',
        // 日志等级
        'levels' => ['info'],
        // 被收集记录的额外数据
        'logVars' => ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION','_SERVER'],
        // 指定日志保存的文件名
        'logFile' => '@app/runtime/logs/info/app.log',
        // 是否开启日志 (@app/runtime/logs/info/20151223_app.log)
        'enableDatePrefix' => true,
        'maxFileSize' => 1024 * 1,
        'maxLogFiles' => 100,
      ],
      /**
       * trace 级别日志：记录关于某段代码运行的相关消息。主要是用于开发环境。
       * 使用方法：Yii::trace()
       */
      [
        'class' => 'common\components\FileTarget',
        // 日志等级
        'levels' => ['trace'],
        // 被收集记录的额外数据
        'logVars' => ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION','_SERVER'],
        // 指定日志保存的文件名
        'logFile' => '@app/runtime/logs/trace/app.log',
        // 是否开启日志 (@app/runtime/logs/trace/20151223_app.log)
        'enableDatePrefix' => true,
        'maxFileSize' => 1024 * 1,
        'maxLogFiles' => 100,
      ],
    ],
  ],
],

Yii 로그 로직
Yii은 계층적 로그 처리 메커니즘, 즉 로그 수집 및 최종 로그 처리(예: 표시, 파일 저장, 데이터 저장)은 별개입니다.
로그 정보 수집은 CLogger(로그 기록기)에 의해 완료되며, 로그 정보의 배포 및 처리는 CLogRouter의 스케줄링(로그 라우팅이라고 함)에 따라 처리 개체(예: CFileLogRoute 및 CLogRoute에서 상속된 로깅 디렉터리)에 배포됩니다. (log processor) 클래스) 소스 코드를 반복해서 읽은 후에는 Yii의 이러한 계층화된 처리 방식을 통해 유연하게 확장할 수 있다는 점에 깊은 인상을 받았습니다.
로그 정보는 일반 정보, 프로필, 추적, 경고, 오류 수준 등의 수준으로 구분됩니다. CFileRoute의 수준 속성을 지정하여 지정된 로그 정보만 처리하도록 설정하는 등 로그 라우팅에서 필터링 조건을 설정할 수 있습니다. 수준.
프로그램에서 호출되는 경우:

Yii::log($message,CLogger::LEVEL_ERROR,$category);

해당 프로세스는 다음과 같습니다.

• Generate CLogger 인스턴스

• YII_DEBUG 및 YII_TRACE_LEVEL이 유효한 값으로 정의되고 로그 수준이 프로파일링하지 않은 경우 통화 추적 정보를 생성하여 로그 정보에 추가합니다.

• CLogger::log($msg,$level,$category)를 호출하여 로그를 수집합니다. 실제로 로그는 이때 파일에 기록되지 않고 메모리에 일시적으로 저장됩니다.

질문: 파일에 로그가 언제 기록되었나요?
반복적인 추적 끝에 프로세서 CLogRouter::processLogs()가 CLogRouter 클래스의 init 메소드에 있는 Application 객체의 OnEndRequest 이벤트에 바인딩되어 있음을 발견했습니다. 동시에 이벤트 프로세서 CLogRouter::collectLogs 메소드는 Yii::$_logger의 onFlush 이벤트에도 바인딩됩니다. 이는 로그가 너무 많을 때 적시에 로그를 새로 고치고 파일에 쓰는 데 사용됩니다. Yii::log()의 메시지. 코드는 다음과 같습니다:

/**
 * Initializes this application component.
 * This method is required by the IApplicationComponent interface.  
*/
 public function init(){ 
  parent::init(); 
  foreach($this->_routes as $name=>$route) { 
    $route=Yii::createComponent($route);  
    $route->init();  
    $this->_routes[$name]=$route; 
  } 
  Yii::getLogger()->attachEventHandler('onFlush',array($this,'collectLogs')); 
  Yii::app()->attachEventHandler('onEndRequest',array($this,'processLogs'));}

그리고 CApplication::run() 메소드에 정의되어 있습니다:

 if($this->hasEventHandler('onEndRequest')) {
 $this->onEndRequest(new CEvent($this));
 }

이 시점에서 우리는 CLogger(Yii::$_logger )는 Collect(콘텐츠 구조에 기록)만 기록하고, 프로그램이 끝나면 $app 개체는 로그 처리를 위해 CLogRouter의 processLogs를 호출합니다. Yii는 다중 로그 라우팅을 지원합니다. 예를 들어, 동일한 로그를 파일에 기록하거나, 페이지에 표시하거나, 이메일을 통해 동시에 보낼 수도 있고, 심지어 동시에 데이터베이스에 기록할 수도 있습니다. 구성 파일의 로그: 경로 구성은 여러 경로 배포를 달성하기 위해 log:routes에 대한 여러 요소를 구성하여 구현됩니다. 로그 정보의 필터링 및 기록은 최종 로그 프로세서에서 처리됩니다.
로그 프로세서가 완료해야 하는 작업에는 주로 다음 사항이 포함됩니다. CLogger에서 모든 로그를 가져와 필터링합니다(주로 log:routes:levels/categories로 정의된 수준 및 범주)

첫 번째 필터, CFileLogRoute:: The를 참조하세요. CollectLogs()의 논리:

 $logs=$logger->getLogs($this->levels,$this->categories); //执行过滤，只得到期望信息

로그 필터링이 완료된 후 로그의 최종 처리(예: 파일 쓰기, 데이터베이스에 기록 등)

 CFileLogRoute::processLogs($logs);

그런데 이 기능 중에는 로그 디렉터리에 쓰기 가능한지 여부만 판단하는 작은 버그가 있습니다. CFileLogRoute는 Linux와 유사한 로그 회전 기능(LogRoate)을 구현하고 있습니다. 매우 사려 깊은 로그 파일 크기입니다. 저도 이 파일에서 배우고 그 아이디어를 흡수하고 싶습니다.

'preload'=>array('log'),
components => array(
       'log'=>array(
         'class'=>'CLogRouter',
         'routes'=>array(
          array(
            'class'=>'CFileLogRoute',
            'levels'=>'error, warning,trace',
          ),
         )
        ）
       ）

定义log组件需要预先加载（实例化）。配置使用CLogRouter作为日志路由管理器，并设置了其日志路由处理器(routes属性)及其配置属性。而preload, log属性的定义，均要应用到CWebApplication对象上（请参阅CApplication::__construct中的configure调用, configure从CModule继承而来）。而在CWebApplication的构造函数中执行preloadComponents(),就创建了log对象（即CLogRouter的实例）。
创建并初始化一个组件时，实际上调用的是CModule::getComponent, 这个调用中使用YiiBase::createComponent创建组件对象，并再调用组件的init初始化之。
再阅读CLogRouter::init()过程，在这里有两个关键之处，一是创建日志路由处理器（即决定日志的最终处理方式：写入文件，邮件发送等等），二是给应用程序对象绑定onEndRequest事件处理CLogRouter::processLogs()。而在CApplication::run()确实有相关代码用于运行onEndRequest事件处理句柄：

 if($this->hasEventHandler('onEndRequest')) {
  $this->onEndRequest(new CEvent($this));
 }

也就是说，日志的最终处理（比如写入文件，系统日志，发送邮件）是发生在应用程序运行完毕之后的。Yii使用事件机制，巧妙地实现了事件与处理句柄的关联。
也就是说，当应用程序运行完毕，将执行CLogRouter::processLogs，对日志进行处理,。CLogRouter被称之为日志路由管理器。每个日志路由处理器从CLooger对象中取得相应的日志（使用过滤机制），作最终处理。
具体而言Yii的日志系统，分为以下几个层次：

日志发送者，即程序中调用Yii::log($msg, $level, $category)，将日志发送给CLogger对象
CLogger对象负责将日志记录暂存于内存之中程序运行结束后，log组件（日志路由管理器CLogRoute）的processLogs方法被激活执行，由其逐个调用日志路由器，作日志的最后处理。

更为详细的大致过程如下：

• CApplication::__construct()中调用preloadComponents, 这导致log组件(CLogRoute)被实例化，并被调用init方法初始化。

• log组件(CLogRoute)的init方法中，其是初始化日志路由，并给CApplication对象onEndRequest事件绑定处理流程processLogs。给CLooger组件的onFlush事件绑定处理流程collectLogs。

• 应用程序的其它部分通过调用Yii::log()向CLogger组件发送日志信息，CLogger组件将日志信息暂存到内存中。

• CApplication执行完毕(run方法中)，会激活onEndRequest事件，绑定的事件处理器processLogs被执行，日志被写入文件之中。 Yii的日志路由机制，给日志系统扩展带来了无限的灵活。并且其多道路由处理机制，可将同一份日志信息进行多种方式处理。

这里举出一个案例：发生error级别的数据库错误时，及时给相关维护人员发送电子邮件，并同时将这些日志记录到文件之中。规划思路，发送邮件和手机短信是两个不同的功能，Yii已经带了日志邮件发送组件（logging/CEmailLogRoute.php），但这个组件中却使用了php自带的mail函数，使用mail函数需要配置php.ini中的smtp主机，并且使用非验证发送方式，这种方式在目前的实际情况下已经完全不可使用。代替地我们需要使用带验证功能的smtp发送方式。在protected/components/目录下定义日志处理器类myEmailLogRoute，并让其继承自CEmailLogRoute，最主要的目的是重写CEmailLogRoute::sendEmail()方法  ，其中，SMTP的处理细节请自行完善（本文的重点是放在如何处理日志上，而不是发送邮件上）。
接下来，我们就可以定义日志路由处理，编辑protected/config/main.php, 在log组件的routes组件添加新的路由配置：

'log'=>array(
'class'=>'CLogRouter',
'routes'=>array(
array(
'class'=>'CFileLogRoute',
'levels'=>'error, warning,trace',
),
array(
'class' => 'myEmailLogRoute',
'levels' => 'error', #所有异常的错误级别均为error, 
'categories' => 'exception.CDbException', #数据库产生错误时，均会产生CDbException异常。
'host' => 'mail.163.com',
'port' => 25,
'user' => 'jeff_yu',
'password' => 'you password',
'timeout' => 30,
'emails' => 'jeff_yu@gmail.com', #日志接收人。
'sentFrom' => 'jeff_yu@gmail.com',
),

经过以上处理，即可使之实现我们的目的，当然你可以根据自己的需要进一步扩展之。

以上就是本文的全部内容，希望对大家的学习有所帮助，更多相关内容请关注PHP中文网！

相关推荐：

Yii2框架实现数据库常用操作解析

关于yii2中结合gridview使用modal弹窗的代码

위 내용은 PHP Yii 프레임워크의 로깅 기능 정보의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!