brainbits/monolog-sentry

brainbits sentry

3.1.1 2025-07-31 12:19 UTC

Requires

• php: ^8.3
• ext-iconv: *
• bgalati/monolog-sentry-handler: ^2.1
• monolog/monolog: ^3.0
• nyholm/psr7: ^1.2.1
• psr/log: ^3.0
• sentry/sentry: ^4.6.1
• symfony/config: ^7.2
• symfony/dependency-injection: ^7.2
• symfony/http-client: ^7.2
• symfony/http-kernel: ^7.2
• symfony/yaml: ^7.2

Requires (Dev)

• brainbits/phpcs-standard: ^8.0
• ergebnis/phpstan-rules: ^2.10.5
• nyholm/nsa: ^1.3
• phpstan/phpstan: ^2.1.21
• phpstan/phpstan-phpunit: ^2.0.7
• phpunit/phpunit: ^12.2.9
• symfony/console: ^7.2
• symfony/http-foundation: ^7.2
• symfony/messenger: ^7.2
• symfony/security-bundle: ^7.2

Suggests

• symfony/console: For the console listener
• symfony/messenger: For the messenger resetter
• symfony/security-bundle: For the user listener

proprietary

README

This package provides a opiniated factory for bgalati/monolog-sentry-handler, based on the provided symfony guide.

Required configuration:

# brainbits_monolog_sentry.yaml

parameters:
    env(SENTRY_DSN): ''
    env(SENTRY_ENVIRONMENT): ''

services:
    _defaults:
        autowire: true
        autoconfigure: true

    Brainbits\MonologSentry\SentryFactory: ~

    Sentry\State\HubInterface:
        factory: ['@Brainbits\MonologSentry\SentryFactory', 'create']
        arguments:
            $dsn: '%env(SENTRY_DSN)%'
            $environment: '%env(SENTRY_ENVIRONMENT)%'
            $inAppInclude: ['%kernel.project_dir%/src']
            $inAppExclude: ['%kernel.cache_dir%', '%kernel.project_dir%/vendor']
            $prefixes: ['%kernel.project_dir%']
            $release: 'web-%app_version%'
            $tags:
                foo: bar
            $logger: '@logger'

    # or
    
    Sentry\State\HubInterface:
        factory: ['@Brainbits\MonologSentry\SentryFactory', 'createFromOptions']
        arguments:
            $options:
                dsn: '%env(SENTRY_DSN)%'
                environment: '%env(SENTRY_ENVIRONMENT)%'
                inAppInclude: ['%kernel.project_dir%/src']
                inAppExclude: ['%kernel.cache_dir%', '%kernel.project_dir%/vendor']
                prefixes: ['%kernel.project_dir%']
                release: 'web-%app_version%'
                tags:
                    foo: bar
                logger: '@logger'

    Controlling\Sentry\Sentry\SentryHandler: ~

    Controlling\Sentry\EventListener\SentryConsoleListener: ~
    Controlling\Sentry\EventListener\SentryRequestListener:
    Controlling\Sentry\EventListener\SentryUserListener:
    Controlling\Sentry\EventListener\MonologResetterEventListener: ~

Example monolog configuration:

# monolog.yaml

when@prod:
    monolog:
        handlers:
            sentry:
                type: fingers_crossed
                process_psr_3_messages: true
                action_level: warning
                handler: sentry_buffer
                excluded_http_codes: [400, 401, 403, 404, 405]
                buffer_size: 100 # Prevents memory leaks for workers
                channels: ["!event", "!security"]
            sentry_buffer:
                type: buffer
                handler: sentry_handler
            sentry_handler:
                type: service
                id: 'Brainbits\MonologSentry\SentryHandler'