Symfony Live 2015 Paris - Monitorer sa prod

blackfire.io @blackfireio
#blackfireio
Faites plaisir à vos
utilisateurs :
surveillez votre prod
Symfony Live Paris 2015
1

View Slide

#blackfireio
Qui suis-je ?
● Grégoire Pineau
● Devops pour Blackfire // SensioLabs
● twitter / Github : @lyrixx
2

View Slide

Log Log Log
3

View Slide

#blackfireio
Erreur PHP
C’est l’histoire d’une fatal erreur …
… en prod …
4

View Slide

#blackfireio5

View Slide

#blackfireio
… Oups … pas d’histoire
● page blanche
● pas de logs
● pas d’alerte
=> ça c’était avant (Symfony <= 2.3)
6

View Slide

#blackfireio
Sommaire
● Pourquoi logger ?
● Avec Monolog ?
● Et dans Symfony ?
● Et les erreurs PHP ?
7

View Slide

Pourquoi logger ?
8

View Slide

#blackfireio
● Suivre un flow d'exécution
● Comprendre du code
● Trouver les bugs
● Résoudre les bugs ?
Pour debugger
9

View Slide

#blackfireio
Pour monitorer
● Recevoir un mail à chaque erreur
● Recevoir une notification slack
● Envoyer ses logs dans:
○ Sentry
○ Elasticsearch (coucou @odolbeau)
○ …
○ => Pour agrégation
● ...
10

View Slide

PSR/3
LoggerInterface
11

View Slide

#blackfireio
psr/log 1.0
● https://packagist.org/packages/psr/log
● Psr\Log\LoggerInterface
● Quelques Traits / Outils
● Psr\Log\LogLevel
12

View Slide

#blackfireio
Les niveaux de logs
DEBUG Information pour le debug
INFO Évènement intéressant
NOTICE Évènement intéressant, mais occasionnel
WARNING Évènement occasionnel, qui n'impacte pas l’utilisateur
ERROR Erreur lors de l’execution
CRITICAL Erreur grave, qui doit etre résolu le plus rapidement
ALERT Erreur grave, qui doit etre résolu encore + rapidement
EMERGENCY WTF OMG BBQ !!! Plus rien de marche
13

View Slide

Et avec monolog ?
14

View Slide

#blackfireio
#!/usr/bin/env php
require __DIR__.'/../vendor/autoload.php';
$logger = new Monolog\Logger('app');
$logger->debug('the user wants to logout.');
$logger->info('the user is logged out.');
15

View Slide

#blackfireio
#!/usr/bin/env php
require __DIR__.'/../vendor/autoload.php';
$logger = new Monolog\Logger('app');
$context = [
'username' => 'alice',
'email' => '[email protected]',
];
$logger->info('new registration.', $context);
16

View Slide

#blackfireio
Logger dans symfony
Il y a un service “logger”:
/** @Route("/log", name="log") */
public function logAction()
{
$logger = $this->get('logger');
$logger->debug('MY DEBUG LOG');
$logger->info('MY INFO LOG');
}
17

View Slide

#blackfireio
Logger dans symfony
Que l’on peut aussi injecter:
services:
workflow:
class: AppBundle\Workflow\Workflow
arguments: ["@logger"]
18

View Slide

#blackfireio
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
class Workflow
{
private $logger;
function __construct(LoggerInterface $logger = null)
{
$this->logger = $logger ?: new NullLogger();
}
}
19

View Slide

Les handlers
(dispatcher ses logs)
20

View Slide

#blackfireio
Les handlers
Votre code LOG Monolog
Slack
app/logs/prod.log
Elasticsearch
Sentry
21

View Slide

C’est tout ?
Non !
22

View Slide

Les channels
(grouper ses logs)
23

View Slide

#blackfireio
Détail d’un log
24

View Slide

#blackfireio
Les channels
● Permet de grouper les logs
● Permet de filtrer facilement les logs
● Ne pas hésiter à en “créer” (5 .. 20)
● Il en existe déjà dans symfony
○ assetic
○ doctrine
○ event
○ php
○ profiler
○ request
○ ...
25

View Slide

#blackfireio
services:
workflow:
class: AppBundle\Workflow\Workflow
arguments: ["@logger"]
tags:
-
name: monolog.logger
channel: workflow
26

View Slide

Les processors
(Enrichir ses logs)
27

View Slide

#blackfireio
Les Processors
● Permet d’ajouter plus d’informations
○ => extra
● Permet de retravailler les logs
○ => context
28

View Slide

#blackfireio
Détail d’un log
29

View Slide

#blackfireio
[2015-04-08 21:14:50]
app.INFO:
add product to cart.
{
"product":"sf live paris 2015","quantity": 1
}
{
"user": {
"username":"alice",
"email":"[email protected]"
}
}
30

View Slide

#blackfireio
Ajouter plus d’information
● Processor natif et à mettre en place:
○ WebProcessor: URI + Method + IP du client
○ UidProcessor: Ajoute un unique id par
■ Requête HTTP
■ Command
● Custom (par exemple):
○ UserProcessor: ajoute des informations sur l’
utilisateur connecté
○ RequestContextProcessor: ajoute un potentiel
unique id dans les headers de la requête (SOA)
31
Attention aux
consumers

View Slide

#blackfireio
namespace AppBundle\Monolog\Processor;
class UserProcessor
{
public function __invoke(array $record)
{
return $record;
}
}
32

View Slide

#blackfireio
use Symfony\Component\DependencyInjection\Container;
class UserProcessor
{
protected $container;
public function __construct(Container $container)
{
$this->container = $container;
}
}
33
WHATTT !!

View Slide

#blackfireio
{
$user = $this->container
->get('security.token_storage')
->getToken()
->getUser();
$record['extra']['user'] = [
'username' => $user->getUsername(),
'uuid' => $user->getUuid(),
];
return $record;
}
34
Attention !!

View Slide

#blackfireio
[2015-04-08 20:11:21]
app.INFO:
new registration.
[]
{
"user": {
"username":"alice",
"email":"[email protected]"
}
}
35

View Slide

C’est tout ?
Non !
36

View Slide

#blackfireio
Mettre en forme le context
● Permet de retravailler le tableau
“context”
● Par exemple:
○ extraire le nom d’un produit
○ extraire le titre d’un article
○ ...
37

View Slide

#blackfireio
$product = new Product('sf live paris 2015', 10);
$this->get('logger')->debug('add product to cart.', [
'product' => $product,
'quantity' => 1,
]);
38

View Slide

#blackfireio
[2015-04-08 21:27:50]
app.DEBUG:
{
"product":"[object] (...\\Product: {})",
"quantity":1
}
[]
39

View Slide

#blackfireio
[2015-04-08 21:34:12]
app.DEBUG:
{
"product":{
"name":"sf live paris 2015",
"price":10
},
"quantity":1
}
[]
40

View Slide

#blackfireio
class ProductProcessor
{
{
if (!isset($record['context']['product'])) {
return $record;
}
$product = $record['context']['product'];
if (!$product instanceof Product) {
return $record;
}
$record['context']['product'] = [
'name' => $product->getName(),
'price' => $product->getPrice(),
];
return $record;
}
}
41

View Slide

#blackfireio
Résumé
● On injecte le logger partout !
● On log, on log, on log et on log
● On utilise des channels
● On utilise des processors pour enrichir
ses logs:
○ ip
○ url
○ user connecté
● On utilise des processors pour mettre en
forme le context
42

View Slide

Et les erreurs PHP ?
43

View Slide

#blackfireio
Le saviez vous ?
● Pour Symfony <= 2.5
○ Les fatal errors PHP ne sont pas logguées
● Pour Symfony >= 2.6
○ Les fatal errors PHP sont logguées
○ Les notices PHP ne sont pas logguées
● Pour Symfony >= 2.[7|8]
○ Les notices PHP sont logguées
44

View Slide

#blackfireio
Tirer parti de symfony
● pour Symfony <= 2.5
○ utiliser le Monolog\ErrorHandler
● pour Symfony >= 2.6
○ utiliser
Symfony\Component\Debug\ErrorHandler
Dans tous les cas, on branche le logger
dans l’error handler.
45

View Slide

Nouveau channel
46

View Slide

#blackfireio
#config.yml
monolog:
channels:
- php_error
47

View Slide

Configuration de l’application
(Symfony 2.6+)
48

View Slide

#blackfireio
class AppKernel extends Kernel
{
public function boot()
{
parent::boot();
if (false === $this->debug) {
$handler = ErrorHandler::register();
$handler->throwAt(0, true);
$handler->scopeAt(0, true);
$handler->traceAt(E_ALL, true);
$logger = $this->container->get('monolog.logger.php_error');
$handler->setDefaultLogger($logger);
}
}
}
49

View Slide

#blackfireio
ErrorHandler
Pour quel niveau d’erreur PHP: en prod ?
throwAt On lance une exception 0 => rien
scopeAt On log les variables de la backtrace 0 => rien
traceAt On ajoute la stracktrace dans le log E_ALL => tout
50

View Slide

#blackfireio
Attention au mapping
Attention au mapping des erreurs PHP sur les
niveaux d’erreurs Monolog / PSR.
Dans Symfony 2.5 .. 2.6, ils ne sont pas
parfaits.
Pour moi, une notice PHP est du niveau d’une
error Monolog / PSR
51

View Slide

C’est tout ?
Oui ...
52

View Slide

#blackfireio
Merci
Questions ?
53

View Slide

#blackfireio
SensioLabs Recrute
Contactez moi ;)
54

View Slide

Symfony Live 2015 Paris - Monitorer sa prod

Symfony Live 2015 Paris - Monitorer sa prod

Grégoire Pineau

More Decks by Grégoire Pineau

Other Decks in Technology

Featured

Transcript