Como usar o Monolog para escrever Logs

O Monolog é uma biblioteca de log para o PHP 5.3 usada pelo Symfony2. É inspirado pela biblioteca LogBook do Python.

Utilização

Para fazer o log de uma mensagem, basta obter o serviço logger a partir do container em seu controlador:

public function indexAction()
{
    $logger = $this->get('logger');
    $logger->info('I just got the logger');
    $logger->err('An error occurred');

    // ...
}

O serviço logger possui métodos diferentes para os níveis de log. Para mais detalhes sobre os métodos que estão disponíveis, veja Symfony\Component\HttpKernel\Log\LoggerInterface.

Manipuladores (handlers) e Canais (channels): Escrevendo logs em locais diferentes

No Monolog, cada logger define um canal de log, que organiza as suas mensagens de log em diferentes “categorias”. Então, cada canal tem uma pilha de manipuladores para escrever os logs (os manipuladores podem ser compartilhados).

Tip

Ao injetar o logger em um serviço você pode usar um canal personalizado para controlar que “canal” o logger irá realizar o log.

O manipulador básico é o StreamHandler, que grava logs em um stream (por padrão em app/logs/prod.log no ambiente prod e app/logs/dev.log no ambiente dev).

O Monolog também vem com um poderoso manipulador integrado para realizar log no ambiente prod: FingersCrossedHandler. Ele permite que você armazene as mensagens em um buffer e registre o log somente se a mensagem alcança o nível de ação (ERROR na configuração fornecida na edição standard), enviando as mensagens para outro manipulador.

Usando vários manipuladores

O logger usa uma pilha de manipuladores que são chamados sucessivamente. Isto permite registrar facilmente as mensagens de várias maneiras.

A configuração acima define uma pilha de manipuladores que será chamada na ordem em que eles são definidos.

Tip

O manipulador chamado “file” não será incluído na própria pilha, pois, ele é usado como um manipulador aninhado do manipulador fingers_crossed.

Note

Se você quiser alterar a configuração do MonologBundle em outro arquivo de configuração, você precisa redefinir toda a pilha. Não pode ser feito o merge porque a ordem é importante e um merge não permite controlar a ordem.

Alterando o formatador

O manipulador usa um Formatter para formatar o registro antes de efetuar o log. Todos os manipuladores do Monolog usam uma instância do Monolog\Formatter\LineFormatter por padrão, mas você pode substituí-lo facilmente. O formatador deve implementar Monolog\Formatter\FormatterInterface.

Adicionando alguns dados extras nas mensagens de log

O Monolog permite processar o registro antes de fazer o log para adicionar alguns dados extras. Um processador pode ser aplicado para toda a pilha do manipulador ou somente para um manipulador específico.

Um processador é simplesmente um callable recebendo o registro como seu primeiro argumento.

Os processadores são configurados usando a tag DIC monolog.processor. Veja a referencia sobre ela.

Adicionando uma Sessão/Token de Pedido

Às vezes, é difícil dizer que entradas no log pertencem a qual sessão e/ou pedido. O exemplo a seguir irá adicionar um token exclusivo para cada pedido utilizando um processador.

namespace Acme\MyBundle;

use Symfony\Component\HttpFoundation\Session\Session;

class SessionRequestProcessor
{
    private $session;
    private $token;

    public function __construct(Session $session)
    {
        $this->session = $session;
    }

    public function processRecord(array $record)
    {
        if (null === $this->token) {
            try {
                $this->token = substr($this->session->getId(), 0, 8);
            } catch (\RuntimeException $e) {
                $this->token = '????????';
            }
            $this->token .= '-' . substr(uniqid(), -8);
        }
        $record['extra']['token'] = $this->token;

        return $record;
    }
}

Note

Se você usa vários manipuladores, você também pode registrar o processador no nível do manipulador, em vez de globalmente.