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. Он фильтрует все сообщения журнала по категориям и экспортирует их в файл, базу данных и / или электронную почту.

Step 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' => ['[email protected]'],
                  'to' => ['[email protected]', '[email protected]'],
                  '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

Step 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]";
   }
]

Приведенный выше фрагмент кода настраивает цель журнала для префикса всех сообщений журнала с текущим идентификатором пользователя.

По умолчанию сообщения журнала включают значения из этих глобальных переменных PHP: $ _GET, $_POST, $_SESSION, $_COOKIE, $_FILES и $ _SERVER. Чтобы изменить это поведение, вы должны настроитьyii\log\Target::$logVars свойство с именами переменных, которые вы хотите включить.

Все сообщения журнала хранятся в массиве объектом регистратора. Объект регистратора сбрасывает записанные сообщения в целевые объекты журнала каждый раз, когда массив накапливает определенное количество сообщений (по умолчанию 1000).

Step 3 - Чтобы настроить этот номер, вам следует позвонить в flushInterval property.

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

Даже когда объект регистратора сбрасывает сообщения журнала в целевые объекты журнала, они не экспортируются немедленно. Экспорт происходит, когда цель журнала накапливает определенное количество сообщений (по умолчанию 1000).

Step 4 - Чтобы настроить это число, вы должны настроить exportInterval свойство.

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

Step 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 и exportIntevalproperties на 1, чтобы все сообщения журнала немедленно появлялись в файлах журнала. Мы также опускаем свойство level цели журнала. Это означает, что сообщения журнала всех категорий (ошибка, предупреждение, информация, трассировка) появятся в файлах журнала.

Step 6 - Затем создайте функцию с именем actionLog () в SiteController.

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

В приведенном выше коде мы просто записываем в файлы журнала четыре сообщения журнала разных категорий.

Step 7 - Введите URL http://localhost:8080/index.php?r=site/logв адресной строке веб-браузера. Сообщения журнала должны появляться в каталоге app / runtime / logs в файле app.log.