Logs, pra que te quero! @ TDC SP 2017

Globalcode – Open4education
Arquitetura PHP – Logs, pra que te quero!
Gabriel Machado
ZCPE, MCSA SQL Server, Developer @ Leroy Merlin

O que são Logs?
“Quando o homem avançou o mar, na época dos grandes
descobrimentos, para deixar registrado os eventos
ocorridos durante a viagem foi comum a criação de um log,
no sentido de ser um 'diário de bordo’.” - Wikipedia

O que são Logs?

CARACTERÍSTICAS DE UM BOM LOG
Logs, pra que te quero!

Ser claro e informativo
// Não tão claro
[2017-07-20 02:41:11] INFO: foi
[2017-07-20 02:41:11] DEBUG: vai
[2017-07-20 02:41:11] NOTICE: passou!!
[2017-07-20 02:41:11] DEBUG: 2
[2017-07-20 02:41:11] DEBUG: 3
[2017-07-20 02:41:11] DEBUG: 4
// Pouco informativo
[2017-07-20 02:41:11] WARNING: Unable to sync Sale Order

Ter contexto
// Explicar o que está acontecendo
[2017-07-20 02:48:25] INFO: Starting csv file import {"file":"/path/file.csv"} []
[2017-07-20 02:48:25] DEBUG: Reading csv file [] []
[2017-07-20 02:48:25] NOTICE: Skip header {"line":1} []
[2017-07-20 02:48:25] DEBUG: Loading row 2 {"line":2,"data":{"some":"data"}} []
// Incluir informações sobre o contexto
[2017-07-20 02:48:25] WARNING: Unable to sync Sale Order {"id":123}
{"file":"/mnt/c/Users/gabri/Projects/tdc/good-logs.php","line":32,"class":null,"function":null}

Fácil de pesquisar e agrupar
// Repensar logs com mensagem dinâmica
ERROR: Allowed memory size of 5202142 bytes exhausted (tried to allocate 370697 bytes)
// Incluir tags
INFO: Starting csv file import {"file":"/path/file.csv"} {"tags":["integration","product"]}
NOTICE: Skip header {"line":1} {"tags":["integration","product"]}
DEBUG: Loading row 2 {"line":2,"data":{"some":"data"}} {"tags":["integration","product"]}

Utilizar níveis de criticidade

Analise seus logs
Antecipe problemas analisando seus logs
Tenha rotinas para ver logs não críticos
Não use seus logs só para apagar incêndios

NÍVEIS DE CRITICIDADE

Níveis de Criticidade
Debug
Contém informações detalhadas para
debug
Geralmente é desligado em produção
(Ex: Iterações de um loop, query SQL
gerada pelo ORM)0
1
2
3
4
5
6
7
8
Level

Info
Eventos comuns ocorridos no sistema
(Ex.: Usuário fez login, hits na API)
0
1
2
3
4
5
6
7
8
Level

Notice
Eventos comuns, porém com certa
relevância no sistema
0
1
2
3
4
5
6
7
8
Level

Warning
Eventos não caracterizados como erro,
mas que merecem uma certa atenção
(Ex.: Uso de funções descontinuadas)
0
1
2
3
4
5
6
7
8
Level

Error
Erros encontrados em tempo de
execução
Exceptions não tratadas aparecem aqui
0
1
2
3
4
5
6
7
8
Level

Critical
Condições críticas no sistema, como
falha de serviços externos
Pode ser usado para medir nível de
serviço (SLA)
0
1
2
3
4
5
6
7
8
Level

Alert
Requer uma ação corretiva imediata
Aqui alguém vai te ligar, enviar SMS,
@channel no Slack, sinal de fumaça
0
1
2
3
4
5
6
7
8
Level

Emergency
Sistema está em um estado não
utilizável
É raro no nível da aplicação
0
1
2
3
4
5
6
7
8
Level

E NO PHP, COMO FAZ?

PSR-3
Padrão de Logs para PHP
De acordo com os níveis de criticidade da IETF
RFC 5424
Algumas implementações: monolog, zend-log,
log4php
Especificação da PSR-3

Monolog
Handlers
Destino do log
Formatters
Formato em que o log será enviado
Processors
Informações extras para o log

Handlers
StreamHandler
RotatingFileHandler
SlackWebhookHandler
MandrillHandler
NewRelicHandler
LogEntriesHandler
NullHandler

Formatters
LineFormatter
HtmlFormatter
JsonFormatter
ChromePHPFormatter
LogstashFormatter

Processors
PsrLogMessageProcessor
IntrospectionProcessor
WebProcessor
MemoryPeakUsageProcessor
GitProcessor
TagProcessor

Exemplos
<?php
require_once __DIR__ . '/vendor/autoload.php';
use MonologHandlerStreamHandler;
use MonologLogger;
$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler(__DIR__.'/my_app.log'));
$logger->info('Hello World!');
// my_app.log:
[2017-07-20 00:51:27] my_logger.INFO: Hello World! [] []

Exemplos
use MonologHandlerRotatingFileHandler;
$logger->pushHandler(new RotatingFileHandler(__DIR__.'/error.log', 3, Logger::ERROR));
$logger->debug('Debug event');
$logger->error('Error event');
// my_app.log:
[2017-07-20 01:10:21] my_logger.DEBUG: Debug event [] []
[2017-07-20 01:10:21] my_logger.ERROR: Error event [] []
// error-2017-07-20.log

Exemplos
use MonologProcessorIntrospectionProcessor;
$logger->pushProcessor(new IntrospectionProcessor(Logger::WARNING));
$logger->notice('Important event');
$logger->warning('Deprecated: Lorem Ipsum...');
// my_app.log:
[2017-07-20 01:25:02] my_logger.NOTICE: Important event [] []
[2017-07-20 01:26:03] my_logger.WARNING: Deprecated: Lorem Ipsum... []
{"file":"/mnt/c/Users/gabri/Projects/tdc/bootstrap.php","line":21,"class":null,"function":null}

Exemplos
$data = ['user' => 'TDC'];
$logger->info('User '. $data['user'] .' logged', $data); // without Psr Processor
use MonologProcessorPsrLogMessageProcessor;
$logger->info('User {user} logged', $data); // with Psr Processor
// my_app.log:
[2017-07-20 01:25:02] my_logger.INFO: User TDC logged {"user":"TDC"} []

Exemplos
$rotatingFileHandler = $logger->popHandler();
$fileHandler = $logger->popHandler();
$htmlHandler = new StreamHandler(__DIR__.'/log.html', Logger::DEBUG);
use MonologFormatterLineFormatter; use MonologFormatterJsonFormatter;
use MonologFormatterHtmlFormatter;
$fileHandler->setFormatter(new LineFormatter("%level_name%: %message% %context% %extra%n"));
$rotatingFileHandler->setFormatter(new JsonFormatter());
$htmlHandler->setFormatter(new HtmlFormatter());
$logger->setHandlers([$fileHandler, $rotatingFileHandler, $htmlHandler]);
$logger->error('Unhandled Expection: Lorem ipsum', ['user' => 'TDC']);
$logger->critical('User {user} is trying to hack us!', ['id' => 666, 'user' => 'TDC',]);

Exemplos
// my_app.log
ERROR: Unhandled Expection: Lorem ipsum {"user":"TDC"}
CRITICAL: User TDC is trying to hack us! {"id":666,"user":"TDC"}

Exemplos
// error-2017-07-20.log
{"message":"Unhandled Expection: Lorem
ipsum","context":{"user":"TDC"},"level":400,"level_name":"ERROR","channel":"my_logger","datetime
":{"date":"2017-07-20
02:00:18.608935","timezone_type":3,"timezone":"UTC"},"extra":{"file":"/mnt/c/Users/gabri/Project
s/tdc/bootstrap.php","line":51,"class":null,"function":null}}
{"message":"User TDC is trying to hack
us!","context":{"id":666,"user":"TDC"},"level":500,"level_name":"CRITICAL","channel":"my_logger"
,"datetime":{"date":"2017-07-20
02:00:18.610325","timezone_type":3,"timezone":"UTC"},"extra":{"file":"/mnt/c/Users/gabri/Project
s/tdc/bootstrap.php","line":52,"class":null,"function":null}}

Exemplos

ANALISANDO OS LOGS

Como visualizar?
Na sua maquina local, pode acessar diretamente o
arquivo
$ tail -f /path/to/log

Como visualizar?
Em produção, caso tenha acesso a máquina via
ssh
$ ssh -i ~/.ssh/key.pem user@host tail –f /path/to/log
E se seu ambiente for composto por 35 hosts?

Você pode precisar de
Agregação e centralização de logs
Pesquisa por determinadas ocorrências
Geração de métricas (KPIs e SLA)
Alertas e notificações

Serviços Externos

Sentry

Resumindo...
Organize os logs gerados pela aplicação
Crie processos de revisão periódica dos logs
Automatize o envio de alertas
Centralize os logs da aplicação
Cruze com outros logs (servidor web, banco de
dados)

OBRIGADO!
gmsantos
gmsantos__
gmsantos
gmsantos
Exemplos disponíveis em:
https://github.com/gmsantos/tdc-php-logs

Logs, pra que te quero! @ TDC SP 2017

Recomendados

Recomendados

Mais conteúdo relacionado

Semelhante a Logs, pra que te quero! @ TDC SP 2017

Semelhante a Logs, pra que te quero! @ TDC SP 2017 (20)

Mais de Gabriel Machado

Mais de Gabriel Machado (10)

Logs, pra que te quero! @ TDC SP 2017