mrandmrssmith/monolog-bugsnag-bundle

Bugsnag integration for Monolog and Symfony.

v3.0.0 2023-06-02 09:51 UTC

This package is auto-updated.

Last update: 2024-04-22 17:15:45 UTC


README

A Bugsnag Handler Bundle for Symfony Monolog

It is compatible and tested with;

  • PHP 8.1, 8.2 & Symfony 5.4 LTS
  • PHP 8.1, 8.2 & Symfony 6.2, 6.3

Installation

🏗️

  1. If you haven't already, create a Bugsnag account.
  2. Add this package to your project.
    composer require mrandmrssmith/monolog-bugsnag-bundle
  3. Enable the bundle
    // config/bundles.php
    
    return [
       //...
       \MrAndMrsSmith\MonologBugsnagBundle\MonologBugsnagBundle::class => ['all' => true],
    ];

Usage

📔

Configure bugsnag

Find the bugsnag.yaml file in config/packages and fill the API key provided in the bugsnag project settings.

Add a new monolog handler

Find the monolog.yaml and add a new handler like:

monolog:
    handlers:
        # ... other handlers definitions
        bugsnag:
            type: service
            id: 'monolog.bugsnag_handler'

We cannot configure a minimum level for service's handler. The default min-level is WARNING. Plan is to be able to parametrize it at some point.

Test it

/** @var LoggerInterface $logger **/
$logger->error('Error message');

Support

🤗 Please consider contributing if you feel you can improve this package, otherwise submit an issue via the GitHub page and include as much information as possible, including steps to reproduce, platform versions and anything else to help pinpoint the root cause.

Contributing

👍 If you do contribute, we thank you, but please review the CONTRIBUTING document to help us ensure the project is kept consistent and easy to maintain.

Versioning

⌛ This project will follow Semantic Versioning 2.0.0.

Changes

🛠️ All project changes/releases are noted in the GitHub releases page and in the CHANGELOG file.

Following conventions laid out by keep a changelog.

Credits

🙏 Thanks to the contributors of MonoSnag from which this library is highly inspired.