Configuración

El bundle se configura bajo un único árbol monitor, por convención en config/packages/monitor.yaml. Cada valor corresponde directamente a los tipos del núcleo monitor-php que el bundle conecta por usted.

Referencia completa

# 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 = traza completa (por defecto); un valor positivo recorta
    code_snippets: true    # líneas de código alrededor de los frames de la aplicación; false envía solo archivo y línea
    environments: []
    scrub: ['password', 'password_confirmation', 'passphrase', 'token', 'signature', 'secret', 'authorization', 'cookie', 'referer', 'referrer', 'api_key']
    redact: ['email', 'iban', 'nir', 'card', 'phone']
    redact_custom: {}   # sus propias formas, con el formato etiqueta: patrón PCRE
    logs:
        enabled: false
        level: warning
        max_batch: 200

Opciones

Claves de enmascaramiento por defecto

Cuando usted no define scrub, el bundle utiliza:

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

Definir scrub reemplaza esta lista: recuerde volver a incluir los valores por defecto que desee conservar. A partir de la versión 0.3.1, el enmascaramiento alcanza también la URL reportada con cada excepción, un valor JSON escrito como cadena, y los valores que lleva el mensaje de un log cuando empieza por una URL o es JSON: vea Uso.

Enmascaramiento por la forma del valor

scrub mira el nombre de la clave. Nunca ve una dirección escrita en el texto libre de un mensaje de excepción, en un segmento de URL, o en un campo que alguien llamó reference. redact mira el valor, en su propio servidor, antes de cualquier envío, y está activo por defecto con las cinco formas.

Ese valor por defecto ya se aplicaba antes de estar declarado aquí, y por eso conviene decirlo con claridad: el bundle enmascaraba valores que no documentaba en ninguna parte, y cualquier intento de configurarlo fallaba en la compilación del contenedor con Unrecognized option. Ambas claves forman ya parte del árbol.

monitor:
    # Quitar las formas que producen falsos positivos con sus datos
    redact: ['email', 'iban', 'card']

    # O enviar los payloads tal cual
    redact: []

    # Sus propias formas
    redact_custom:
        customer_ref: '/CUST-\d{6}/'

Las formas que llevan un dígito de control se verifican y no solo se reconocen: una referencia de pedido de dieciséis dígitos no se toma por un número de tarjeta, y cada máscara nombra lo que ocultó ([redacted:email]), de modo que el mensaje sigue siendo legible.

Variables de entorno

Nada le obliga a usar variables de entorno, pero es el patrón recomendado para mantener los secretos fuera del repositorio. Un cableado típico:

# 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=su-token-de-proyecto
MONITOR_RELEASE=

La forma %env(default::MONITOR_RELEASE)% recurre a un valor vacío cuando la variable no está definida, y release queda por tanto simplemente vacío.

Restringir los entornos

Por defecto (environments: []), el bundle reporta desde todos los entornos, incluido dev. Para reportar únicamente desde producción:

monitor:
    environments: ['prod']

Tanto el event subscriber de excepciones como el handler de logs de Monolog comparan esta lista con kernel.environment antes de cualquier envío: en cualquier otro entorno, nada sale de su aplicación, ni excepciones ni logs.

Correspondencia configuración / servicios

Consulte Uso para conocer el comportamiento de estos servicios en tiempo de ejecución.