Yii - Logging

O Yii fornece uma estrutura altamente personalizável e extensível. Com a ajuda desta estrutura, você pode registrar facilmente vários tipos de mensagens.

Para registrar uma mensagem, você deve chamar um dos seguintes métodos -

Yii::error() - Registra uma mensagem de erro fatal.
Yii::warning() - Grava uma mensagem de aviso.
Yii::info() - Grava uma mensagem com algumas informações úteis.
Yii::trace() - Grava uma mensagem para rastrear como um trecho de código é executado.

Os métodos acima registram mensagens de log em várias categorias. Eles compartilham a seguinte assinatura de função -

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

onde -

$message - A mensagem de log a ser gravada
$category - A categoria da mensagem de log

Uma maneira simples e conveniente de esquema de nomenclatura é usando a constante mágica PHP __METHOD__. Por exemplo -

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

Um alvo de log é uma instância da classe yii \ log \ Target. Ele filtra todas as mensagens de log por categorias e as exporta para arquivo, banco de dados e / ou e-mail.

Step 1 - Você pode registrar vários destinos de log também, como.

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

No código acima, dois destinos são registrados. O primeiro destino seleciona todos os erros, avisos, rastreamentos e mensagens informativas e os salva em um banco de dados. O segundo destino envia todas as mensagens de erro e aviso para o e-mail do administrador.

O Yii fornece os seguintes destinos de log integrados -

yii\log\DbTarget - Armazena mensagens de log em um banco de dados.
yii\log\FileTarget - Salva mensagens de log em arquivos.
yii\log\EmailTarget - Envia mensagens de registro para endereços de e-mail predefinidos.
yii\log\SyslogTarget - Salva mensagens de log no syslog chamando a função PHP syslog ().

Por padrão, as mensagens de log são formatadas da seguinte forma -

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

Step 2 - Para personalizar este formato, você deve configurar o yii\log\Target::$prefixpropriedade. Por exemplo.

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

O fragmento de código acima configura um destino de log para prefixar todas as mensagens de log com o ID do usuário atual.

Por padrão, as mensagens de log incluem os valores dessas variáveis PHP globais: $ _GET, $_POST, $_SESSÃO, $_COOKIE, $_FILES e $ _SERVER. Para modificar este comportamento, você deve configurar oyii\log\Target::$logVars propriedade com os nomes das variáveis que você deseja incluir.

Todas as mensagens de log são mantidas em uma matriz pelo objeto logger. O objeto logger liberou as mensagens gravadas para os destinos de log cada vez que o array acumula um certo número de mensagens (o padrão é 1000).

Step 3 - Para personalizar este número, você deve ligar para o flushInterval property.

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

Mesmo quando o objeto logger libera mensagens de log para destinos de log, elas não são exportadas imediatamente. A exportação ocorre quando um destino de log acumula um certo número de mensagens (o padrão é 1000).

Step 4 - Para personalizar este número, você deve configurar o exportInterval propriedade.

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

Step 5 - Agora, modifique o config/web.php arquivar desta forma.

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

No código acima, definimos o componente do aplicativo de log, definimos o flushInterval e exportIntevalpropriedades para 1 para que todas as mensagens de log apareçam nos arquivos de log imediatamente. Também omitimos a propriedade de níveis do destino do log. Isso significa que mensagens de log de todas as categorias (erro, aviso, informações, rastreamento) aparecerão nos arquivos de log.

Step 6 - Em seguida, crie uma função chamada actionLog () no SiteController.

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

No código acima, apenas gravamos quatro mensagens de log de diferentes categorias nos arquivos de log.

Step 7 - Digite o URL http://localhost:8080/index.php?r=site/logna barra de endereço do navegador da web. As mensagens de log devem aparecer no diretório app / runtime / logs no arquivo app.log.

↰ Previous page Next page ↱