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 类的一个实例。它按类别过滤所有日志消息并将它们导出到文件、数据库和/或电子邮件。

第 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() 将日志消息保存到 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' => [...],
      ],
   ],
];

即使记录器对象将日志消息刷新到日志目标，它们也不会立即导出。当日志目标累积一定数量的消息（默认为 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' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      '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，以便所有日志消息立即出现在日志文件中。我们还省略了日志目标的级别属性。这意味着所有类别的日志消息（错误、警告、信息、跟踪）都将出现在日志文件中。

第 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');
}

在上面的代码中，我们只是将四个不同类别的日志消息写入日志文件。

第 7 步- 在 Web 浏览器的地址栏中键入 URL http://localhost:8080/index.php?r=site/log。日志消息应该出现在 app.log 文件的 app/runtime/logs 目录下。