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 [ // "log"组件在引导期间加载 '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 属性。
所有日志消息都由记录器对象保存在一个数组中。每次数组累积一定数量的消息(默认值为 1000)时,记录器对象都会将记录的消息刷新到日志目标。
步骤 3 − 要自定义此数字,您应该调用 flushInterval 属性。
return [ 'bootstrap' => ['log'], 'components' => [ 'log' => [ 'flushInterval' => 50, // 默认值为 1000 'targets' => [...], ], ], ];
即使记录器对象将日志消息刷新到日志目标,它们也不会立即导出。当日志目标累积一定数量的消息时(默认值为 1000),就会发生导出。
步骤 4 − 要自定义此数字,您应该配置 exportInterval 属性。
[ 'class' => 'yii\log\FileTarget', 'exportInterval' => 50, // 默认值为 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', // 默认将所有邮件发送到一个文件。您必须设置 // 'useFileTransport' 为 false 并配置传输 // 以便邮件程序发送真实的电子邮件。 '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) { // 针对"dev"环境的配置调整 $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'); }
在上面的代码中,我们只是将四个不同类别的日志消息写入日志文件。
步骤 7 − 在 Web 浏览器的地址栏中输入 URL http://localhost:8080/index.php?r=site/log。日志消息应出现在 app.log 文件的 app/runtime/logs 目录下。
