Yii - Logowanie

Yii dostarcza wysoce konfigurowalny i rozszerzalny framework. Za pomocą tego frameworka możesz łatwo rejestrować różne typy wiadomości.

Aby zarejestrować wiadomość, należy wywołać jedną z następujących metod -

Yii::error() - Rejestruje krytyczny komunikat o błędzie.
Yii::warning() - Nagrywa komunikat ostrzegawczy.
Yii::info() - Nagrywa wiadomość z przydatnymi informacjami.
Yii::trace() - Rejestruje komunikat, aby śledzić, jak działa fragment kodu.

Powyższe metody rejestrują komunikaty dziennika w różnych kategoriach. Dzielą następujący podpis funkcji -

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

gdzie -

$message - Komunikat dziennika do zarejestrowania
$category - kategoria komunikatu dziennika

Prostym i wygodnym sposobem nazewnictwa jest użycie magicznej stałej PHP __METHOD__. Na przykład -

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

Cel dziennika to instancja klasy yii \ log \ Target. Filtruje wszystkie komunikaty dziennika według kategorii i eksportuje je do pliku, bazy danych i / lub poczty e-mail.

Step 1 - Możesz również zarejestrować wiele celów dziennika, na przykład.

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',
               ],
            ],
         ],
      ],
   ],
];

W powyższym kodzie zarejestrowane są dwa cele. Pierwszy cel wybiera wszystkie błędy, ostrzeżenia, ślady i komunikaty informacyjne i zapisuje je w bazie danych. Drugi cel wysyła wszystkie komunikaty o błędach i ostrzeżenia na e-mail administratora.

Yii zapewnia następujące wbudowane cele dziennika -

yii\log\DbTarget - Przechowuje komunikaty dziennika w bazie danych.
yii\log\FileTarget - Zapisuje komunikaty dziennika w plikach.
yii\log\EmailTarget - Wysyła komunikaty dziennika na predefiniowane adresy e-mail.
yii\log\SyslogTarget - Zapisuje komunikaty dziennika do syslog poprzez wywołanie funkcji PHP syslog ().

Domyślnie komunikaty dziennika mają następujący format -

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

Step 2 - Aby dostosować ten format, należy skonfigurować plik yii\log\Target::$prefixwłasność. Na przykład.

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

Powyższy fragment kodu konfiguruje cel dziennika, aby poprzedzać wszystkie komunikaty dziennika bieżącym identyfikatorem użytkownika.

Domyślnie komunikaty dziennika zawierają wartości z tych globalnych zmiennych PHP: $ _GET, $_POST, $_SESJA, $_COOKIE, $_FILES i $ _SERVER. Aby zmodyfikować to zachowanie, należy skonfigurowaćyii\log\Target::$logVars właściwość z nazwami zmiennych, które chcesz dołączyć.

Wszystkie komunikaty dziennika są przechowywane w tablicy przez obiekt rejestrujący. Obiekt rejestrujący przesuwał nagrane komunikaty do celów dziennika za każdym razem, gdy tablica gromadzi określoną liczbę komunikatów (domyślnie 1000).

Step 3 - Aby dostosować ten numer, zadzwoń pod numer flushInterval property.

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

Nawet jeśli obiekt rejestrujący opróżnia komunikaty dziennika do celów dziennika, nie są one natychmiast eksportowane. Eksport ma miejsce, gdy cel dziennika zgromadzi określoną liczbę komunikatów (domyślnie 1000).

Step 4 - Aby dostosować ten numer, należy skonfigurować plik exportInterval własność.

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

Step 5 - Teraz zmodyfikuj plik config/web.php plik w ten sposób.

<?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;
?>

W powyższym kodzie definiujemy składnik aplikacji dziennika, ustawiamy plik flushInterval i exportIntevalproperties na 1, tak aby wszystkie komunikaty dziennika pojawiały się natychmiast w plikach dziennika. Pomijamy również właściwość poziomów celu dziennika. Oznacza to, że w plikach dziennika pojawią się komunikaty dziennika wszystkich kategorii (błędy, ostrzeżenia, informacje, ślady).

Step 6 - Następnie utwórz funkcję o nazwie actionLog () w kontrolerze witryny.

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

W powyższym kodzie po prostu zapisujemy cztery komunikaty dziennika z różnych kategorii do plików dziennika.

Step 7 - Wpisz adres URL http://localhost:8080/index.php?r=site/logw pasku adresu przeglądarki internetowej. Komunikaty dziennika powinny pojawiać się w katalogu app / runtime / logs w pliku app.log.