Configuration

Le bundle se configure sous une unique arborescence monitor, par convention dans config/packages/monitor.yaml. Chaque valeur correspond directement aux types du cœur monitor-php que le bundle câble pour vous.

Référence complète

# config/packages/monitor.yaml
monitor:
    enabled: true
    url: '%env(MONITOR_URL)%'
    key: '%env(MONITOR_KEY)%'
    timeout: 3
    release: '%env(default::MONITOR_RELEASE)%'
    trace_limit: 0    # 0 = trace complète (défaut) ; une valeur positive tronque
    code_snippets: true    # lignes de source autour des frames de l'application ; false n'envoie que fichier et ligne
    environments: []
    scrub: ['password', 'password_confirmation', 'passphrase', 'token', 'signature', 'secret', 'authorization', 'cookie', 'referer', 'referrer', 'api_key']
    redact: ['email', 'iban', 'nir', 'card', 'phone']
    redact_custom: {}   # vos propres formes, sous la forme libellé: motif PCRE
    logs:
        enabled: false
        level: warning
        max_batch: 200

Options

Clés de masquage par défaut

Lorsque vous ne définissez pas scrub, le bundle utilise :

password, password_confirmation, passphrase, token, signature, secret, authorization, cookie, referer,
referrer, api_key

Définir scrub remplace cette liste : pensez à y réinclure les valeurs par défaut que vous souhaitez conserver. À partir de la version 0.3.1, le masquage atteint aussi l'URL rapportée avec chaque exception, une valeur JSON écrite en chaîne, et les valeurs que porte le message d'un log quand il commence par une URL ou qu'il est du JSON : voir Usage.

Masquage par la forme de la valeur

scrub regarde le nom de la clé. Il ne voit jamais une adresse écrite dans le texte libre d'un message d'exception, dans un segment d'URL, ou dans un champ que quelqu'un a appelé reference. redact regarde la valeur, sur votre propre serveur, avant tout envoi, et il est actif par défaut avec les cinq formes.

Ce défaut s'appliquait déjà avant d'être déclaré ici, et c'est la raison de le dire clairement : le bundle masquait des valeurs qu'il ne documentait nulle part, et toute tentative de le configurer échouait à la compilation du conteneur avec Unrecognized option. Les deux clés font désormais partie de l'arborescence.

monitor:
    # Retirer les formes qui produisent des faux positifs sur vos données
    redact: ['email', 'iban', 'card']

    # Ou envoyer les charges telles quelles
    redact: []

    # Vos propres formes
    redact_custom:
        customer_ref: '/CUST-\d{6}/'

Les formes qui portent une clé de contrôle sont vérifiées et non simplement reconnues : une référence de commande à seize chiffres n'est pas prise pour un numéro de carte, et chaque masque nomme ce qu'il a caché ([redacted:email]), si bien que le message reste lisible.

Variables d'environnement

Rien ne vous oblige à utiliser des variables d'environnement, mais c'est le motif recommandé pour garder les secrets hors du dépôt. Un câblage typique :

# config/packages/monitor.yaml
monitor:
    url: '%env(MONITOR_URL)%'
    key: '%env(MONITOR_KEY)%'
    release: '%env(default::MONITOR_RELEASE)%'
    environments: ['prod']

# .env.local
MONITOR_URL=https://monitor.example.com
MONITOR_KEY=votre-jeton-de-projet
MONITOR_RELEASE=

La forme %env(default::MONITOR_RELEASE)% retombe sur une valeur vide quand la variable n'est pas définie, et release reste donc simplement vide.

Restreindre les environnements

Par défaut (environments: []), le bundle remonte depuis tous les environnements, y compris dev. Pour ne remonter que depuis la production :

monitor:
    environments: ['prod']

L'event subscriber d'exception comme le handler de logs Monolog vérifient cette liste contre kernel.environment avant tout envoi : dans tout autre environnement, rien ne quitte votre application, ni exceptions ni logs.

Correspondance configuration / services

Consultez Usage pour le comportement de ces services à l'exécution.