macpaw/sentry-monolog-adapter

Sentry monolog logging bundle

1.0.0 2024-03-15 10:14 UTC

Requires

• php: ^8.1
• sentry/sentry-symfony: ^4.0
• symfony/console: ^5.4 || ^6.0 || ^7.0
• symfony/dotenv: ^5.4 || ^6.0 || ^7.0
• symfony/messenger: ^5.4 || ^6.0 || ^7.0
• symfony/monolog-bundle: ^3.0

Requires (Dev)

• phpstan/phpstan: ^1.3
• squizlabs/php_codesniffer: 3.5.*
• symfony/phpunit-bridge: ^5.4 || ^6.0 || ^7.0
• symfony/yaml: ^5.4 || ^6.0 || ^7.0

MIT

• Yozhef Hisem
• Ihor Roik

• logging
• symfony
• monolog
• sentry
• MacPaw

README

Version	Build Status	Code Coverage
master
develop

The Sentry Monolog Adapter is a Symfony bundle designed to enhance and provide granular control over logging to Sentry. It is particularly powerful for applications that use the Symfony Messenger component, allowing you to implement intelligent logging strategies to avoid log floods and focus on critical errors.

Key Features

• Advanced Log Processing: Utilizes a decorator for Monolog's Sentry handler to process and enrich log records before they are sent.
• Customizable Processors: Add your own processors to include or modify contextual data, with a built-in ExceptionProcessor to get you started.
• Intelligent Messenger Logging: A dedicated middleware for the Symfony Messenger component that allows you to control which messages are logged based on flexible strategies.
• Built-in Logging Strategies: A suite of strategies is provided out-of-the-box, including:
  • LogAllFailedStrategy: Only logs messages that fail.
  • LogAfterPositionStrategy: Logs messages after a specific number of retries.
  • ArithmeticProgressionStrategy: Logs based on an arithmetic sequence of retry attempts.
  • And several others to fit your needs.
• Modern and Compatible: Built for PHP 8.1+ and compatible with sentry/sentry-symfony v5.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute:

Applications that use Symfony Flex

$ composer require macpaw/sentry-monolog-adapter

Applications that don't use Symfony Flex

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require macpaw/sentry-monolog-adapter

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            SentryMonologAdapter\SentryMonologAdapterBundle::class => ['all' => true],
        );

        // ...
    }

    // ...
}

Create Sentry Monolog Adapter Config:

config/packages/sentry_monolog_adapter.yaml

Configurating logging strategies of MessengerLoggingMiddleware - all strategies you can see here.

sentry_monolog_adapter:
    messenger_logging_middleware:
        logging_strategies: // array of logging strategies
            - id: sentry_monolog_adapter.log_after_position_strategy
              options:
                  position: 3
            - id: sentry_monolog_adapter.log_all_failed_strategy

Step 3: Configuration

Monolog:

config/packages/monolog.yaml

        sentry:
            type: service
            id: sentry_monolog_adapter.monolog_handler_decorator

Messenger:

config/packages/messenger.yaml

        middleware:
            ....
            - sentry_monolog_adapter.messenger_logging_middleware
            ....

Step 4: Additional settings

It is possible to add preprocessors for putting your parameters to the additional data. Our library provides a basic implementation, but at any time we can replace it with our own implementation

sentry_monolog_adapter:
    monolog_handler_decorator:
        processors:
            - sentry_monolog_adapter.exception_processor