Home  >  Article  >  Backend Development  >  Detailed explanation of the related configuration and use of logs in PHP's Yii framework_php skills

Detailed explanation of the related configuration and use of logs in PHP's Yii framework_php skills

WBOY
WBOYOriginal
2016-05-16 20:03:23997browse

The default log is output to protected/runtime/application.log

If you need to modify it, you need to add the log configuration under components in main.php, as follows:

'preload' => array('log'),//这句也必须加上

'components' => array( 
    'log'=>array( 
      'class'=>'CLogRouter', 
      'routes'=>array(
        //这是一个文件route表示category为test开头的所有类型的输出都会记录到runtime/test.log下面 
         array( 
           'class'=>'CFileLogRoute', 
           'levels'=>'trace, info, debug, warn, error, fatal, profile', 
           'categories'=>'test.*', 
           'maxFileSize'=>1048576,//单文件最大1G 
           'logFile'=>'test.log', 
         ), 
         // 
 
//        开发过程中所有日志直接输出到浏览器了,这样不需要登录服务器看日志了  

           
         array( 
          'class' => 'CWebLogRoute', 
          'categories' => 'test.*', 
          'levels' => CLogger::LEVEL_PROFILE, 
          'showInFireBug' => true, 
          'ignoreAjaxInFireBug' => true, 
        ), 
        array( 
          'class' => 'CWebLogRoute', 
          'categories' => 'test.* ', 
        ), 

        array( 
          'class'=>'CEmailLogRoute', 
          'levels'=>'error, warning', 
          'emails'=>'admin@example.com', 
        ), 
      ), 
    ), 
 
  ),


If Yii::log("jdkshgds","info",'test.xx');
is called somewhere

This log is first recorded in an array of CLogger class in the memory, and then each LogRoute will be judged one by one to determine whether it needs to be output. Note that it is judged one by one, not one of them outputs and the next one is ignored.

Take the above configuration as an example:

The first CFileLogRoute, 'categories'=>'test.*', levels contains info, test.xx meets the conditions, so it will be executed, and this log will be output to test.log, and then the next CWebLogRoute, 'levels' => CLogger::LEVEL_PROFILE,. And this log is info, so it will not be executed. The next CWebLogRoute, 'categories' => 'test.* ', the levels are not specified, that means no filtering, so this will also be executed, so this The log will be output to the browser.

2. Profile function
In addition, logger also has a very powerful function: profile,

Yii::beginProfile('blockID');
...code block being profiled...
Yii::endProfile('blockID');

This way you can test the execution efficiency of this code block, which is very convenient.

View more detailed configuration: http://www.yiiframework.com/doc/api/1.1/CProfileLogRoute

Then there is also a very buggy function, Profiling SQL Executions

Many times poorly written SQL statements will greatly affect efficiency, but profiling is required to determine which statement affects efficiency. YII also provides this bug-level functionality.

3. Use of Yii::log() and Yii::trace()
First set the log in the config file

'log'=>array(
  'class'=>'CLogRouter',
  'routes'=>array(
    array(
      'class'=>'CFileLogRoute',//这表示把日志输出到文件中,下方有详细的
      'levels'=>'error, warning',
    ),
    array(
      'class'=>'CWebLogRoute',//这表示把日志显示在网页下方,下方有详细的
      'levels'=>'trace, info, error, warning',
      'categories'=>'cool.*,system.db.*',
    ),
  ),
),


Log routing class:

  • CDbLogRoute: Save information to a database table.
  • CEmailLogRoute: Send information to the specified Email address.
  • CFileLogRoute: Save information to a file in the application's runtime directory.
  • CWebLogRoute: Display information at the bottom of the current page.
  • CProfileLogRoute: Display profiling information at the bottom of the page.

Information levels:

  • trace: This is the level used in Yii::trace. It is used to track the execution flow of a program during development.
  • info: This is used to record common information.
  • profile: This is a performance overview (profile). More detailed instructions will follow shortly.
  • warning: This is used for warning information.
  • error: This is used for fatal error messages.

Categories:

Can be customized, but it will be written to the log only if it is matched in the output function
(For example, if cool.* and system.db.* are written above, the corresponding category information will be written to the log. Please understand it in conjunction with the following)

After setting up, you can use the log function to record:

Yii::trace('My log message.','cool.pd');
//cool.pd属于cool.*分类,所以会被写入日志
Yii::log('My log message.','info','cool.collectpd');
//log定义级别为info,结合上文,第一个logclass会忽略,不会被写入文件,但会被第二个logclass接收,写入日志在网络下方显示。


The difference between trace() and log():
trace() will only take effect in debug mode, that is, when debug is turned on
trace() does not distinguish between levels, but log() can set the levels parameter


4. Debugging the time it takes to execute each statement of sql query
Add the following Route under the log in the configuration

//这个配置专门负责数据库操作的profile 
array( 
    'class'=>'CProfileLogRoute', 
    'levels' => CLogger::LEVEL_PROFILE, 
    'showInFireBug' => true, 
    'ignoreAjaxInFireBug' => true, 
    'categories' => 'system.db.* ', //只记录db的操作日志,其他的忽略 
),

Then add in an action of a controller:

Yii::beginProfile('db', 'pocketpet'); 
for($i=0;$i<1000;$i++){ 
   $user = UserModel::model()->findByPk("1");//这里只要是数据库操作就行,这个只是个例子 
}

Yii::endProfile('db', 'pocketpet');

To access this action in the browser, remember to open firebug first, and then you can see the record as shown below in firebug:

2015128153707541.jpg (600×83)

The same query will be classified and total and average calculated. This is very helpful for analysis.

You can also write the db log to a file, the configuration is as follows (not recommended, it is more convenient to use firebug in the browser):

array( 
  'class'=>'CFileLogRoute', 
  'levels' => CLogger::LEVEL_PROFILE, 
  'categories' => 'system.db.* ', //只记录db的操作日志,其他的忽略 
  'logFile'=>'db.log', 
),

Of course, in order to take effect, the following two steps of configuration are required:

1. Remember to add the following configuration to index.php,

$yii = dirname(__FILE__).'/../yii/framework/yii.php';
$config = dirname(__FILE__).'/protected/config/main.php';

defined('YII_DEBUG') or define('YII_DEBUG',true);

defined('YII_DEBUG_SHOW_PROFILER') or define('YII_DEBUG_SHOW_PROFILER',true);
//enable profiling
defined('YII_DEBUG_PROFILING') or define('YII_DEBUG_PROFILING',true);
//trace level
defined('YII_TRACE_LEVEL') or define('YII_TRACE_LEVEL',3);
//execution time
defined('YII_DEBUG_DISPLAY_TIME') or define('YII_DEBUG_DISPLAY_TIME',false);
require_once($yii);
Yii::createWebApplication($config)->run();

2. In the main.php main configuration file, set enableProfiling to true in the components db

'components' => array(
'db' => array(
    'enableProfiling' => true, //这个是用来记录日志的,会记录每一条语句执行的时间
    'enableParamLogging' => true,//true表示包括sql语句的参数在内的信息都会记录到日志里,非常详细
  ),
)

Statement:
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn