Учебники

Yii — Ведение журнала

Ноябрь 24, 2018

Yii предоставляет настраиваемые и расширяемые рамки. С помощью этой структуры вы можете легко регистрировать различные типы сообщений.

Чтобы записать сообщение, вы должны вызвать один из следующих методов —

  • Yii :: error () — записывает фатальное сообщение об ошибке.

  • Yii :: warning () — записывает предупреждающее сообщение.

  • Yii :: info () — Записывает сообщение с некоторой полезной информацией.

  • Yii :: trace () — записывает сообщение, чтобы проследить, как работает фрагмент кода.

Yii :: error () — записывает фатальное сообщение об ошибке.

Yii :: warning () — записывает предупреждающее сообщение.

Yii :: info () — Записывает сообщение с некоторой полезной информацией.

Yii :: trace () — записывает сообщение, чтобы проследить, как работает фрагмент кода.

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

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

где —

  • $ message — сообщение журнала для записи

  • $ category — категория сообщения журнала

$ 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 — Сохраняет сообщения журнала в syslog, вызывая функцию PHP syslog ().

yii \ log \ DbTarget — Хранит сообщения журнала в базе данных.

yii \ log \ FileTarget — Сохраняет сообщения журнала в файлах.

yii \ log \ EmailTarget — отправляет сообщения журнала на предварительно определенные адреса электронной почты.

yii \ log \ SyslogTarget — Сохраняет сообщения журнала в syslog, вызывая функцию PHP syslog ().

По умолчанию сообщения журнала отформатированы следующим образом: 

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

Шаг 2. Чтобы настроить этот формат, необходимо настроить свойство префикса yii \ log \ Target :: $ . Например. 

[
   '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 с именами переменных, которые вы хотите включить.

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

Шаг 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');
}

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

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

41
Share: