PHP开发教程

Yii日志记录

Yii提供一个高度可定制,可扩展的框架。

有了这个框架的帮助,就可以轻松地记录各种类型的消息。

要日志记录信息/消息,应该调用下面的方法 -

  • Yii::error() − 记录一个致命错误消息

  • Yii::warning() − 记录一个警告消息

  • Yii::info() − 记录一些有用信息的消息

  • Yii::trace() − 记录消息跟踪一段代码如何运行

在上述不同类别方法记录日志信息。都具有以下函数签名 -

function ($message, $category = 'application')

在这里 −

  • $message − 要记录的日志消息

  • $category − 日志消息类别

简单和方便的命名方式是使用 PHP 的 __METHOD__ 魔术常量。例如 -

Yii::info('this is a log message', __METHOD__);

日志目标是 yii\log\Target class 类的一个实例。它通过类别过滤所有日志信息并导出文件、数据库和/或电子邮件。

第1步 - 也可以注册多个日志目标,如下:

return [
   // the "log" component is loaded during bootstrapping time
   'bootstrap' => ['log'],
   'components' => [
      'log' => [
         'targets' => [
            [
               'class' => 'yii\log\DbTarget',
               'levels' => ['error', 'warning', 'trace', 'info'],
            ],
            [
               'class' => 'yii\log\EmailTarget',
               'levels' => ['error', 'warning'],
               'categories' => ['yii\db\*'],
               'message' => [
                  'from' => ['log@mydomain.com'],
                  'to' => ['admin@mydomain.com', 'developer@mydomain.com'],
                  'subject' => 'Application errors at mydomain.com',
               ],
            ],
         ],
      ],
   ],
];

在上面的代码,有两个目标被注册。第一个目标选择了所有的错误,警告,跟踪和信息消息,并在数据库中保存它们。第二个目标将发送所有错误和警告消息到管理员的电子邮件。

Yii提供以下内置日志的目标 -

  • yii\log\DbTarget − 在数据库中存储日志消息

  • yii\log\FileTarget − 在文件中保存记录消息

  • yii\log\EmailTarget − 发送长消息到预先定义的电子邮件地址

  • yii\log\SyslogTarget − 通过调用 PHP syslog()函数将日志信息保存到系统日志

默认情况下,日志消息的格式如下 -

Timestamp [IP address][User ID][Session ID][Severity Level][Category] Message Text

第2步 - 要自定义格式则配置 yii\log\Target::$prefix 属性。 例如。

[
   'class' => 'yii\log\FileTarget',
   'prefix' => function ($message) {
      $user = Yii::$app->has('user', true) ? Yii::$app->get('user') :
      'undefined user';
      $userID = $user ? $user->getId(false) : 'anonym';
      return "[$userID]";
   }
]

上面的代码片段配置日志目标,使用当前用户ID为前缀的日志消息。

默认情况下,日志消息包含这些全局PHP变量的值:$_GET,$_POST,$_SESSION,$_COOKIE,$_FILES 和 $_SERVER。

若要修改此行为,则可以配置 yii\log\Target::$logVars 配置,需要包括变量名。

所有日志信息都保存在由记录对象的数组。 Logger对象每次刷新记录的消息到日志目标,数组积累了一定数量消息(默认为1000)。

第3步 - 要自定义这个数字,则可以调用 flushInterval 属性。

return [
   'bootstrap' => ['log'],
   'components' => [
      'log' => [
         'flushInterval' => 50, // default is 1000
         'targets' => [...],
      ],
   ],
];

即使在Logger对象刷新日志信息记录的目标,它们也不会立即导出。当日志目标积累了一定数量的消息(默认为1000)时就会导出。

第4步 - 要自定义这个数字,可以配置 exportInterval 属性的值。

[
   'class' => 'yii\log\FileTarget',
   'exportInterval' => 50, // default is 1000
]

第5步 - 现在,修改 config/web.php 文件,如下所示代码。

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this
               //is required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [
            'errorAction' => 'site/error',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
         ],
         'log' => [
            'flushInterval' => 1,
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'exportInterval' => 1,
                  'logVars' => []
               ],
            ],
         ],
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'admin' => [
            'class' => 'app\modules\admin\Admin',
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // configuration adjustments for 'dev' environment
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

在上面的代码中,我们定义日志应用程序组件,并设置 flushInterval 和 exportInteval 属性的值为 1 ,以便所有日志消息立即导出在日志文件中。

这里还忽略了日志目标级别(levels )属性。这意味着,所有类别的日志消息(错误,警告,信息,跟踪)将会记录在日志文件中。

第6步 - 然后,在 SiteController 中调用 actionLog() 函数。

public function actionLog() {
   Yii::trace('trace log message');
   Yii::info('info log message');
   Yii::warning('warning log message');
   Yii::error('error log message');
}

在上面的代码中,只写4个不同类型的日志消息到日志文件。

第7步 - 在Web浏览器的地址栏打开 URL http://localhost:8080/index.php?r=site/log 

日志消息出现在 app/runtime/logs 目录下的 app.log 文件中。

11.png

Powered by PHP二次开发 ©2008-2017