Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/macpaw/sentry-monolog-adapter
Symfony Sentry Monolog Messager Adapter
https://github.com/macpaw/sentry-monolog-adapter
logging messager monolog php php-library sentry symfony-bundle
Last synced: 3 months ago
JSON representation
Symfony Sentry Monolog Messager Adapter
- Host: GitHub
- URL: https://github.com/macpaw/sentry-monolog-adapter
- Owner: MacPaw
- License: mit
- Created: 2021-02-03T06:18:36.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-21T13:37:27.000Z (10 months ago)
- Last Synced: 2024-10-13T07:20:56.107Z (3 months ago)
- Topics: logging, messager, monolog, php, php-library, sentry, symfony-bundle
- Language: PHP
- Homepage: https://github.com/MacPaw/sentry-monolog-adapter
- Size: 264 KB
- Stars: 27
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Symfony Sentry Monolog Adapter
=================================
| Version | Build Status | Code Coverage |
|:---------:|:-------------:|:-----:|
| `master`| [![CI][master Build Status Image]][master Build Status] | [![Coverage Status][master Code Coverage Image]][master Code Coverage] |
| `develop`| [![CI][develop Build Status Image]][develop Build Status] | [![Coverage Status][develop Code Coverage Image]][develop Code Coverage] |
Installation
============
Step 1: Download the Bundle
----------------------------------
Open a command console, enter your project directory and execute:
### Applications that use Symfony Flex
```console
$ 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:
```console
$ composer require macpaw/sentry-monolog-adapter
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
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
['all' => true],
);
// ...
}
// ...
}
```
Create Sentry Monolog Adapter Config:
----------------------------------
`config/packages/sentry_monolog_adapter.yaml `
Configurating logging strategies of MessengerLoggingMiddleware - all strategies you can see [here](https://github.com/MacPaw/sentry-monolog-adapter/tree/master/src/Messenger/LoggingStrategy).
```yaml
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 `
```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](https://github.com/MacPaw/sentry-monolog-adapter/blob/feat/addDefaultProcessor/src/Processor/ExceptionProcessor.php), but at any time we can replace it with our own implementation
```yaml
sentry_monolog_adapter:
monolog_handler_decorator:
processors:
- sentry_monolog_adapter.exception_processor
```
[master Build Status]: https://github.com/macpaw/sentry-monolog-adapter/actions?query=workflow%3ACI+branch%3Amaster
[master Build Status Image]: https://github.com/macpaw/sentry-monolog-adapter/workflows/CI/badge.svg?branch=master
[develop Build Status]: https://github.com/macpaw/sentry-monolog-adapter/actions?query=workflow%3ACI+branch%3Adevelop
[develop Build Status Image]: https://github.com/macpaw/sentry-monolog-adapter/workflows/CI/badge.svg?branch=develop
[master Code Coverage]: https://codecov.io/gh/macpaw/sentry-monolog-adapter/branch/master
[master Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/sentry-monolog-adapter/master?logo=codecov
[develop Code Coverage]: https://codecov.io/gh/macpaw/sentry-monolog-adapter/branch/develop
[develop Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/sentry-monolog-adapter/develop?logo=codecov