├── .github
    ├── CODE_OF_CONDUCT.md
    └── FUNDING.yml
├── Block
    └── Adminhtml
    │   └── System
    │       └── Config
    │           └── Form
    │               └── Field
    │                   └── Type.php
├── Config
    └── Source
    │   └── LoggingLevel.php
├── Handler
    ├── ConsoleHandler.php
    ├── GelfHandler.php
    ├── MagentoHandlerInterface.php
    ├── MailHandler.php
    ├── RotatingFileHandler.php
    ├── SlackHandler.php
    └── SocketHandler.php
├── LICENSE
├── Plugin
    └── MonologPlugin.php
├── Processor
    ├── CustomContextProcessor.php
    └── ExceptionProcessor.php
├── README.md
├── Tests
    └── Unit
    │   └── Processor
    │       ├── CustomContextProcessorTest.php
    │       └── ExceptionProcessorTest.php
├── Transport
    └── UdpTransportWrapper.php
├── composer.json
├── etc
    ├── acl.xml
    ├── adminhtml
    │   └── system.xml
    ├── config.xml
    ├── di.xml
    └── module.xml
├── i18n
    └── fr_FR.csv
└── registration.php


/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
 1 | # Contributor Covenant Code of Conduct
 2 | 
 3 | ## Our Pledge
 4 | 
 5 | In the interest of fostering an open and welcoming environment, we as
 6 | contributors and maintainers pledge to making participation in our project and
 7 | our community a harassment-free experience for everyone, regardless of age, body
 8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
 9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 | 
12 | ## Our Standards
13 | 
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 | 
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 | 
23 | Examples of unacceptable behavior by participants include:
24 | 
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 |  advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 |  address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 |  professional setting
33 | 
34 | ## Our Responsibilities
35 | 
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 | 
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 | 
46 | ## Scope
47 | 
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 | 
55 | ## Enforcement
56 | 
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at opengento@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 | 
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 | 
68 | ## Attribution
69 | 
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 | 
73 | [homepage]: https://www.contributor-covenant.org
74 | 
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 | 


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
 1 | # These are supported funding model platforms
 2 | 
 3 | #github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 4 | #patreon: # Replace with a single Patreon username
 5 | #open_collective: # Replace with a single Open Collective username
 6 | #ko_fi: # Replace with a single Ko-fi username
 7 | #tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 8 | #community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
 9 | #liberapay: # Replace with a single Liberapay username
10 | #issuehunt: # Replace with a single IssueHunt username
11 | #otechie: # Replace with a single Otechie username
12 | custom: ['https://www.helloasso.com/associations/opengento/formulaires/1']
13 | 


--------------------------------------------------------------------------------
/Block/Adminhtml/System/Config/Form/Field/Type.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Block\Adminhtml\System\Config\Form\Field;
10 | 
11 | use Magento\Config\Block\System\Config\Form\Field\FieldArray\AbstractFieldArray;
12 | 
13 | class Type extends AbstractFieldArray
14 | {
15 |     protected function _prepareToRender(): void
16 |     {
17 |         $this->addColumn('custom_logger_key', ['label' => __('Logger key')]);
18 |         $this->addColumn('custom_logger_value', ['label' => __('Logger value')]);
19 |         $this->_addAfter = false;
20 |         $this->_addButtonLabel = __('Add');
21 |     }
22 | }
23 | 


--------------------------------------------------------------------------------
/Config/Source/LoggingLevel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Config\Source;
10 | 
11 | use Magento\Framework\Data\OptionSourceInterface;
12 | use Monolog\Logger;
13 | 
14 | class LoggingLevel implements OptionSourceInterface
15 | {
16 |     public function toOptionArray(): array
17 |     {
18 |         return [
19 |             ['value' => Logger::DEBUG, 'label' => __('Debug')],
20 |             ['value' => Logger::INFO, 'label' => __('Info')],
21 |             ['value' => Logger::NOTICE, 'label' => __('Notice')],
22 |             ['value' => Logger::WARNING, 'label' => __('Warning')],
23 |             ['value' => Logger::ERROR, 'label' => __('Error')],
24 |             ['value' => Logger::CRITICAL, 'label' => __('Critical')],
25 |             ['value' => Logger::ALERT, 'label' => __('Alert')],
26 |             ['value' => Logger::EMERGENCY, 'label' => __('Emergency')],
27 |         ];
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/Handler/ConsoleHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Exception;
12 | use Magento\Framework\App\Config\ScopeConfigInterface;
13 | use Monolog\Handler\HandlerInterface;
14 | use Monolog\Handler\StreamHandler;
15 | 
16 | class ConsoleHandler implements MagentoHandlerInterface
17 | {
18 |     public function __construct(
19 |         private ScopeConfigInterface $scopeConfig,
20 |         private string $isEnabled,
21 |         private string $levelPath
22 |     ) {
23 |     }
24 | 
25 |     /**
26 |      * @throws Exception
27 |      */
28 |     public function getInstance(): HandlerInterface
29 |     {
30 |         return new StreamHandler('php://stdout', $this->scopeConfig->getValue($this->levelPath));
31 |     }
32 | 
33 |     public function isEnabled(): bool
34 |     {
35 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/Handler/GelfHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Gelf\PublisherInterface;
12 | use Magento\Framework\App\Config\ScopeConfigInterface;
13 | use Monolog\Handler\GelfHandler as MonologGelfHandler;
14 | use Monolog\Handler\HandlerInterface;
15 | 
16 | class GelfHandler implements MagentoHandlerInterface
17 | {
18 |     public function __construct(
19 |         private PublisherInterface $publisher,
20 |         private ScopeConfigInterface $scopeConfig,
21 |         private string $isEnabled,
22 |         private string $levelPath
23 |     ) {
24 |     }
25 | 
26 |     public function getInstance(): HandlerInterface
27 |     {
28 |         return new MonologGelfHandler(
29 |             $this->publisher,
30 |             $this->scopeConfig->getValue($this->levelPath)
31 |         );
32 |     }
33 | 
34 |     public function isEnabled(): bool
35 |     {
36 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/Handler/MagentoHandlerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Monolog\Handler\HandlerInterface;
12 | 
13 | interface MagentoHandlerInterface
14 | {
15 |     public function getInstance(): HandlerInterface;
16 | 
17 |     public function isEnabled(): bool;
18 | }
19 | 


--------------------------------------------------------------------------------
/Handler/MailHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Magento\Framework\App\Config\ScopeConfigInterface;
12 | use Monolog\Handler\HandlerInterface;
13 | use Monolog\Handler\NativeMailerHandler;
14 | 
15 | class MailHandler implements MagentoHandlerInterface
16 | {
17 |     public function __construct(
18 |         private ScopeConfigInterface $scopeConfig,
19 |         private string $isEnabled,
20 |         private string $toPath,
21 |         private string $subjectPath,
22 |         private string $fromPath,
23 |         private string $levelPath
24 |     ) {
25 |     }
26 | 
27 |     public function getInstance(): HandlerInterface
28 |     {
29 |         return new NativeMailerHandler(
30 |             $this->scopeConfig->getValue($this->toPath),
31 |             $this->scopeConfig->getValue($this->subjectPath),
32 |             $this->scopeConfig->getValue($this->fromPath),
33 |             $this->scopeConfig->getValue($this->levelPath)
34 |         );
35 |     }
36 | 
37 |     public function isEnabled(): bool
38 |     {
39 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/Handler/RotatingFileHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Exception;
12 | use Magento\Framework\App\Config\ScopeConfigInterface;
13 | use Magento\Framework\App\Filesystem\DirectoryList;
14 | use Monolog\Handler\HandlerInterface;
15 | 
16 | class RotatingFileHandler implements MagentoHandlerInterface
17 | {
18 |     public function __construct(
19 |         private ScopeConfigInterface $scopeConfig,
20 |         private DirectoryList $directoryList,
21 |         private string $isEnabled,
22 |         private string $levelPath,
23 |         private string $filenamePath,
24 |         private string $maxFilesPath
25 |     ) {
26 |     }
27 | 
28 |     /**
29 |      * @throws Exception
30 |      */
31 |     public function getInstance(): HandlerInterface
32 |     {
33 |         return new \Monolog\Handler\RotatingFileHandler(
34 |             sprintf(
35 |                 '%s/log/%s',
36 |                 $this->directoryList->getPath(DirectoryList::VAR_DIR),
37 |                 $this->scopeConfig->getValue($this->filenamePath)
38 |             ),
39 |             (int) $this->scopeConfig->getValue($this->maxFilesPath),
40 |             $this->scopeConfig->getValue($this->levelPath)
41 |         );
42 |     }
43 | 
44 |     public function isEnabled(): bool
45 |     {
46 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/Handler/SlackHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Magento\Framework\App\Config\ScopeConfigInterface;
12 | use Monolog\Handler\HandlerInterface;
13 | use Monolog\Handler\MissingExtensionException;
14 | use Monolog\Handler\SlackHandler as MonologSlackHandler;
15 | 
16 | class SlackHandler implements MagentoHandlerInterface
17 | {
18 |     public function __construct(
19 |         private ScopeConfigInterface $scopeConfig,
20 |         private string $isEnabled,
21 |         private string $levelPath,
22 |         private string $tokenPath,
23 |         private string $channelPath,
24 |         private string $usernamePath,
25 |         private string $useAttachmentPath,
26 |         private string $iconEmojiPath,
27 |         private string $bubblePath,
28 |         private string $useShortAttachmentPath,
29 |         private string $includeContextAndExtraPath
30 |     ) {
31 |     }
32 | 
33 |     /**
34 |      * @throws MissingExtensionException
35 |      */
36 |     public function getInstance(): HandlerInterface
37 |     {
38 |         return new MonologSlackHandler(
39 |             $this->scopeConfig->getValue($this->tokenPath),
40 |             $this->scopeConfig->getValue($this->channelPath),
41 |             $this->scopeConfig->getValue($this->usernamePath),
42 |             $this->scopeConfig->isSetFlag($this->useAttachmentPath),
43 |             $this->scopeConfig->getValue($this->iconEmojiPath),
44 |             $this->scopeConfig->getValue($this->levelPath),
45 |             $this->scopeConfig->isSetFlag($this->bubblePath),
46 |             $this->scopeConfig->isSetFlag($this->useShortAttachmentPath),
47 |             $this->scopeConfig->isSetFlag($this->includeContextAndExtraPath)
48 |         );
49 |     }
50 | 
51 |     public function isEnabled(): bool
52 |     {
53 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/Handler/SocketHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Handler;
10 | 
11 | use Exception;
12 | use Magento\Framework\App\Config\ScopeConfigInterface;
13 | use Monolog\Handler\HandlerInterface;
14 | use Monolog\Handler\SocketHandler as MonologSocketHandler;
15 | use Monolog\Formatter\JsonFormatter;
16 | use RuntimeException;
17 | 
18 | class SocketHandler implements MagentoHandlerInterface
19 | {
20 |     public function __construct(
21 |         private ScopeConfigInterface $scopeConfig,
22 |         private string $isEnabled,
23 |         private string $levelPath,
24 |         private string $endpoint
25 |     ) {
26 |     }
27 | 
28 |     /**
29 |      * @throws RuntimeException
30 |      */
31 |     public function getInstance(): HandlerInterface
32 |     {
33 |         $endpointUrl = trim((string) $this->scopeConfig->getValue($this->endpoint));
34 |         if ($endpointUrl === '') {
35 |             throw new RuntimeException(sprintf(
36 |                 'Config key "%s" is missing or empty.',
37 |                 $this->endpoint
38 |             ));
39 |         }
40 | 
41 |         $handler = new MonologSocketHandler($endpointUrl, $this->scopeConfig->getValue($this->levelPath));
42 |         $handler->setFormatter(new JsonFormatter(JsonFormatter::BATCH_MODE_NEWLINES));
43 | 
44 |         return $handler;
45 |     }
46 | 
47 |     public function isEnabled(): bool
48 |     {
49 |         return $this->scopeConfig->isSetFlag($this->isEnabled);
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) OpenGento
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.


--------------------------------------------------------------------------------
/Plugin/MonologPlugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © Magento, Inc. All rights reserved.
 4 |  * See COPYING.txt for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Plugin;
10 | 
11 | use Monolog\Logger;
12 | use Opengento\Logger\Handler\MagentoHandlerInterface;
13 | 
14 | class MonologPlugin
15 | {
16 |     /**
17 |      * @param  MagentoHandlerInterface[]  $magentoHandlers
18 |      */
19 |     public function __construct(private array $magentoHandlers)
20 |     {
21 |     }
22 | 
23 |     /**
24 |      * @param  Logger  $subject
25 |      * @param  array  $handlers
26 |      * @return array
27 |      */
28 |     public function beforeSetHandlers(Logger $subject, array $handlers): array
29 |     {
30 |         foreach ($this->magentoHandlers as $handler) {
31 |             if ($handler->isEnabled()) {
32 |                 array_unshift($handlers, $handler->getInstance());
33 |             }
34 |         }
35 | 
36 |         return [$handlers];
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/Processor/CustomContextProcessor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Processor;
10 | 
11 | use Magento\Framework\App\Config\ScopeConfigInterface;
12 | use Magento\Framework\Serialize\Serializer\Json;
13 | use Magento\Store\Model\ScopeInterface;
14 | use Monolog\LogRecord;
15 | use Monolog\Processor\ProcessorInterface;
16 | 
17 | class CustomContextProcessor implements ProcessorInterface
18 | {
19 |     /**
20 |      * @var ScopeConfigInterface
21 |      */
22 |     private $scopeConfig;
23 | 
24 |     /**
25 |      * @var Json
26 |      */
27 |     private $serializer;
28 | 
29 |     public function __construct(ScopeConfigInterface $scopeConfig, Json $serializer)
30 |     {
31 |         $this->scopeConfig = $scopeConfig;
32 |         $this->serializer = $serializer;
33 |     }
34 | 
35 |     public function __invoke(LogRecord $records): LogRecord
36 |     {
37 |         foreach ($this->resolveTypesLogger() as $value) {
38 |             $records['context'][$value['custom_logger_key']] = $value['custom_logger_value'];
39 |         }
40 | 
41 |         return $records;
42 |     }
43 | 
44 |     private function resolveTypesLogger(?string $store = null): array
45 |     {
46 |         return $this->serializer->unserialize(
47 |             $this->scopeConfig->getValue('loggin/context/types_logger', ScopeInterface::SCOPE_STORE, $store) ?: '{}'
48 |         );
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/Processor/ExceptionProcessor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | namespace Opengento\Logger\Processor;
10 | 
11 | use Monolog\LogRecord;
12 | use Monolog\Processor\ProcessorInterface;
13 | 
14 | class ExceptionProcessor implements ProcessorInterface
15 | {
16 |     public function __invoke(LogRecord $records): LogRecord
17 |     {
18 |         if (isset($records['context']['exception'])) {
19 |             $records['extra']['stacktrace'] = $records['context']['exception']->getTraceAsString();
20 |         }
21 | 
22 |         return $records;
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Gelf Logger Module for Magento 2
 2 | 
 3 | [![Latest Stable Version](https://img.shields.io/packagist/v/opengento/logger.svg?style=flat-square)](https://packagist.org/packages/opengento/logger)
 4 | [![License: MIT](https://img.shields.io/github/license/opengento/logger.svg?style=flat-square)](./LICENSE)
 5 | [![Packagist](https://img.shields.io/packagist/dt/opengento/logger.svg?style=flat-square)](https://packagist.org/packages/opengento/logger/stats)
 6 | [![Packagist](https://img.shields.io/packagist/dm/opengento/logger.svg?style=flat-square)](https://packagist.org/packages/opengento/logger/stats)
 7 | 
 8 | This extension sets new logger handlers for Magento2, such as Gelf or Slack and many others.
 9 | 
10 | - [Setup](#setup)
11 |     - [Composer installation](#composer-installation)
12 |     - [Setup the module](#setup-the-module)
13 | - [Support](#support)
14 | - [Authors](#authors)
15 | - [License](#license)
16 | 
17 | ## Setup
18 | 
19 | Magento 2 Open Source or Commerce edition is required.
20 | 
21 | ### Composer installation
22 | 
23 | Run the following composer command:
24 | 
25 | ```
26 | composer require opengento/logger
27 | ```
28 | 
29 | ### Setup the module
30 | 
31 | Run the following magento command:
32 | 
33 | ```
34 | bin/magento setup:upgrade
35 | ```
36 | 
37 | **If you are in production mode, do not forget to recompile and redeploy the static resources.**
38 | 
39 | ## Support
40 | 
41 | Raise a new [request](https://github.com/opengento/logger/issues) to the issue tracker.
42 | 
43 | ## Authors
44 | 
45 | - **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)
46 | - **Contributors** - *Contributor* - [![GitHub contributors](https://img.shields.io/github/contributors/opengento/logger.svg?style=flat-square)](https://github.com/opengento/logger/graphs/contributors)
47 | 
48 | ## License
49 | 
50 | This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details.
51 | 
52 | ***That's all folks!***
53 | 


--------------------------------------------------------------------------------
/Tests/Unit/Processor/CustomContextProcessorTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | namespace Opengento\Logger\Tests\Unit\Processor;
 8 | 
 9 | use Opengento\Logger\Config\CustomConfiguration;
10 | use Opengento\Logger\Processor\CustomContextProcessor;
11 | use PHPUnit\Framework\TestCase;
12 | 
13 | class CustomContextProcessorTest extends TestCase
14 | {
15 |     /**
16 |      * Tests invoke processor add context information.
17 |      */
18 |     public function testInvokeAddContextInformationIntoRecords(): void
19 |     {
20 |         $records = ['context' => []];
21 |         $customConfigurationStub = $this->createMock(CustomConfiguration::class);
22 |         $customConfigurationStub
23 |             ->method('getUnserializedConfigValue')
24 |             ->willReturn(['env' => 'test']);
25 | 
26 |         $processor = new CustomContextProcessor($customConfigurationStub);
27 |         $records = $processor($records);
28 | 
29 |         $this->assertArrayHasKey('env', $records['context']);
30 |     }
31 | 
32 |     /**
33 |      * Tests invoke processor without anything in custom context array
34 |      */
35 |     public function testInvokeWithoutAddContextInformationIntoRecords(): void
36 |     {
37 |         $records = ['context' => []];
38 | 
39 |         $customConfigurationStub = $this->createMock(CustomConfiguration::class);
40 |         $customConfigurationStub
41 |             ->method('getUnserializedConfigValue')
42 |             ->willReturn(null);
43 | 
44 |         $processor = new CustomContextProcessor($customConfigurationStub);
45 |         $records = $processor($records);
46 | 
47 |         $this->assertArrayNotHasKey('env', $records['context']);
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/Tests/Unit/Processor/ExceptionProcessorTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | namespace Opengento\Logger\Tests\Unit\Processor;
 8 | 
 9 | use LogicException;
10 | use Opengento\Logger\Processor\ExceptionProcessor;
11 | use PHPUnit\Framework\TestCase;
12 | 
13 | /**
14 |  * Tests the exception processor.
15 |  *
16 |  * @package Opengento\Logger\Tests\Unit\Processor
17 |  */
18 | class ExceptionProcessorTest extends TestCase
19 | {
20 |     /**
21 |      * Tests invoke processor add extra information.
22 |      */
23 |     public function testInvokeAddExtraInformationIntoRecords(): void
24 |     {
25 |         $records = ['extra' => [], 'context' => ['exception' => new LogicException('Test')]];
26 | 
27 |         $processor = new ExceptionProcessor();
28 |         $records = $processor($records);
29 | 
30 |         $this->assertArrayHasKey('stacktrace', $records['extra']);
31 |     }
32 | 
33 |     /**
34 |      * Tests invoke processor without exception doesn't add extra information.
35 |      */
36 |     public function testInvokeWithoutAddExtraInformationIntoRecords(): void
37 |     {
38 |         $records = ['extra' => []];
39 | 
40 |         $processor = new ExceptionProcessor();
41 |         $records = $processor($records);
42 | 
43 |         $this->assertArrayNotHasKey('stacktrace', $records['extra']);
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/Transport/UdpTransportWrapper.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Copyright © OpenGento, All rights reserved.
  4 |  * See LICENSE bundled with this library for license details.
  5 |  */
  6 | 
  7 | declare(strict_types=1);
  8 | 
  9 | namespace Opengento\Logger\Transport;
 10 | 
 11 | use Exception;
 12 | use Gelf\MessageInterface as Message;
 13 | use Gelf\Transport\TransportInterface;
 14 | use Gelf\Transport\UdpTransport;
 15 | use Gelf\Transport\UdpTransportFactory;
 16 | use Magento\Framework\App\Config\ScopeConfigInterface;
 17 | use Psr\Log\LoggerInterface;
 18 | 
 19 | use function in_array;
 20 | 
 21 | /**
 22 |  * Class UdpTransportWrapper
 23 |  *
 24 |  * @package Opengento\Logger\Transport
 25 |  */
 26 | class UdpTransportWrapper implements TransportInterface
 27 | {
 28 |     /**
 29 |      * @var UdpTransportFactory
 30 |      */
 31 |     private $transportFactory;
 32 | 
 33 |     /**
 34 |      * @var ScopeConfigInterface
 35 |      */
 36 |     private $scopeConfig;
 37 | 
 38 |     /**
 39 |      * @var LoggerInterface
 40 |      */
 41 |     private $logger;
 42 | 
 43 |     /**
 44 |      * @var string
 45 |      */
 46 |     private $hostPath;
 47 | 
 48 |     /**
 49 |      * @var string
 50 |      */
 51 |     private $portPath;
 52 | 
 53 |     /**
 54 |      * @var string
 55 |      */
 56 |     private $chunkSize;
 57 | 
 58 |     /**
 59 |      * @var string[]
 60 |      */
 61 |     private $ignoredMessages;
 62 | 
 63 |     /**
 64 |      * @var UdpTransport
 65 |      */
 66 |     private $transporter;
 67 | 
 68 |     public function __construct(
 69 |         UdpTransportFactory $transportFactory,
 70 |         ScopeConfigInterface $scopeConfig,
 71 |         LoggerInterface $logger,
 72 |         string $hostPath,
 73 |         string $portPath,
 74 |         string $chunkSize = UdpTransport::CHUNK_SIZE_LAN,
 75 |         array $ignoredMessages = []
 76 |     ) {
 77 |         $this->transportFactory = $transportFactory;
 78 |         $this->scopeConfig = $scopeConfig;
 79 |         $this->logger = $logger;
 80 |         $this->hostPath = $hostPath;
 81 |         $this->portPath = $portPath;
 82 |         $this->chunkSize = $chunkSize;
 83 |         $this->ignoredMessages = $ignoredMessages;
 84 |         unset($this->transporter);
 85 |     }
 86 | 
 87 |     public function __get(string $name)
 88 |     {
 89 |         if ($name === 'transporter') {
 90 |             return $this->{$name} = $this->createTransporter();
 91 |         }
 92 | 
 93 |         return null;
 94 |     }
 95 | 
 96 |     /**
 97 |      * Sends a Message over this transport.
 98 |      *
 99 |      * @param Message $message
100 |      *
101 |      * @return int the number of bytes sent
102 |      */
103 |     public function send(Message $message): int
104 |     {
105 |         if (!in_array($message->getShortMessage(), $this->ignoredMessages, true)) {
106 |             try {
107 |                 return $this->transporter->send($message);
108 |             } catch (Exception $e) {
109 |                 $this->logger->error($e->getMessage(), $e->getTrace());
110 |             }
111 |         }
112 | 
113 |         return 0;
114 |     }
115 | 
116 |     private function createTransporter(): UdpTransport
117 |     {
118 |         return $this->transportFactory->create([
119 |             'host' => $this->scopeConfig->getValue($this->hostPath),
120 |             'port' => $this->scopeConfig->getValue($this->portPath),
121 |             'chunkSize' => $this->chunkSize
122 |         ]);
123 |     }
124 | }
125 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "opengento/logger",
 3 |     "description": "This extension sets new logger handlers for Magento2, such as Gelf or Slack and many others.",
 4 |     "keywords": [
 5 |         "php",
 6 |         "magento",
 7 |         "magento2",
 8 |         "gelf",
 9 |         "ELK",
10 |         "Graylog",
11 |         "Elasticsearch"
12 |     ],
13 |     "require": {
14 |         "php": "^7.1||^8.0",
15 |         "magento/framework": ">=100.1.0",
16 |         "graylog2/gelf-php": "^1.6.0 || ^2.0.0"
17 |     },
18 |     "require-dev": {
19 |         "magento/magento-coding-standard": "^5",
20 |         "magento/marketplace-eqp": "^4.0",
21 |         "roave/security-advisories": "dev-master"
22 |     },
23 |     "type": "magento2-module",
24 |     "license": [
25 |         "MIT"
26 |     ],
27 |     "homepage": "https://github.com/opengento/logger",
28 |     "authors": [
29 |         {
30 |             "name": "Opengento Team",
31 |             "email": "opengento@gmail.com",
32 |             "homepage": "https://opengento.fr/",
33 |             "role": "lead"
34 |         }
35 |     ],
36 |     "support": {
37 |         "source": "https://github.com/opengento/logger",
38 |         "issues": "https://github.com/opengento/logger/issues"
39 |     },
40 |     "autoload": {
41 |         "files": [
42 |             "registration.php"
43 |         ],
44 |         "psr-4": {
45 |             "Opengento\\Logger\\": ""
46 |         }
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/etc/acl.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" ?>
 2 | <!--
 3 | /**
 4 |  * Copyright © OpenGento, All rights reserved.
 5 |  * See LICENSE bundled with this library for license details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
10 |     <acl>
11 |         <resources>
12 |             <resource id="Magento_Backend::admin">
13 |                 <resource id="Magento_Backend::stores">
14 |                     <resource id="Magento_Backend::stores_settings">
15 |                         <resource id="Magento_Config::config">
16 |                             <resource id="Opengento_Logger::config_opengento_logger" title="loggin"/>
17 |                         </resource>
18 |                     </resource>
19 |                 </resource>
20 |             </resource>
21 |         </resources>
22 |     </acl>
23 | </config>
24 | 


--------------------------------------------------------------------------------
/etc/adminhtml/system.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <!--
  3 | /**
  4 |  * Copyright © OpenGento, All rights reserved.
  5 |  * See LICENSE bundled with this library for license details.
  6 |  */
  7 | -->
  8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
  9 |     <system>
 10 |         <tab id="loggin" sortOrder="999" translate="label">
 11 |             <label>Opengento: Advanced Logger</label>
 12 |         </tab>
 13 |         <section id="loggin" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 14 |             <label>Logger</label>
 15 |             <tab>loggin</tab>
 16 |             <resource>Opengento_Logger::config_opengento_logger</resource>
 17 |             <group id="context" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 18 |                 <label>Custom context</label>
 19 |                 <field id="types_logger" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
 20 |                     <label>Custom configuration</label>
 21 |                     <frontend_model>Opengento\Logger\Block\Adminhtml\System\Config\Form\Field\Type</frontend_model>
 22 |                     <backend_model>Magento\Config\Model\Config\Backend\Serialized\ArraySerialized</backend_model>
 23 |                     <comment>Add key with custom value</comment>
 24 |                 </field>
 25 |             </group>
 26 |             <group id="gelf" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 27 |                 <label>Gelf</label>
 28 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label" type="select">
 29 |                     <label>Enabled</label>
 30 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 31 |                 </field>
 32 |                 <field id="transport_host" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label" type="text">
 33 |                     <label>Gelf transport host</label>
 34 |                 </field>
 35 |                 <field id="transport_port" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="15" translate="label" type="text">
 36 |                     <label>Gelf transport port</label>
 37 |                 </field>
 38 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="7" translate="label comment"
 39 |                        type="select">
 40 |                     <label>Level</label>
 41 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
 42 |                     <comment>Messages of this or a higher level will be logged in your log system.</comment>
 43 |                 </field>
 44 |             </group>
 45 |             <group id="console" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 46 |                 <label>Console</label>
 47 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label" type="select">
 48 |                     <label>Enabled</label>
 49 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 50 |                 </field>
 51 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="10" translate="label" type="select">
 52 |                     <label>Level</label>
 53 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
 54 |                 </field>
 55 |             </group>
 56 |             <group id="mail" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 57 |                 <label>Mail</label>
 58 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label" type="select">
 59 |                     <label>Enabled</label>
 60 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 61 |                 </field>
 62 |                 <field id="to" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
 63 |                     <label>To</label>
 64 |                     <comment>To who you want to send the mail, you can specify multiple mails by separating them by a coma (,)</comment>
 65 |                 </field>
 66 |                 <field id="subject" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
 67 |                     <label>Subject</label>
 68 |                     <comment>The subject of the mail</comment>
 69 |                 </field>
 70 |                 <field id="from" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
 71 |                     <label>From</label>
 72 |                     <comment>From who you want to send the mail</comment>
 73 |                 </field>
 74 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="10" translate="label comment" type="select">
 75 |                     <label>Level</label>
 76 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
 77 |                     <comment>Messages of this or a higher level will be logged in mail.</comment>
 78 |                 </field>
 79 |             </group>
 80 |             <group id="file" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
 81 |                 <label>File</label>
 82 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label comment" type="select">
 83 |                     <label>Enabled</label>
 84 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
 85 |                 </field>
 86 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="20" translate="label comment" type="select">
 87 |                     <label>Level</label>
 88 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
 89 |                     <comment>Messages of this or a higher level will be logged in files.</comment>
 90 |                 </field>
 91 |                 <field id="filename" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
 92 |                     <label>File name</label>
 93 |                     <comment>Name of file where the logs must be sent (it will be sent in var/log folder)</comment>
 94 |                 </field>
 95 |                 <field id="max_files" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
 96 |                     <label>Max files</label>
 97 |                     <comment>Messages of this or a higher level will be logged in files.</comment>
 98 |                     <validate>validate-digits validate-zero-or-greater</validate>
 99 |                 </field>
100 |             </group>
101 |             <group id="slack" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
102 |                 <label>Slack</label>
103 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label" type="select">
104 |                     <label>Enabled</label>
105 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
106 |                 </field>
107 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="20" translate="label comment" type="select">
108 |                     <label>Level</label>
109 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
110 |                     <comment>Messages of this or a higher level will be logged in files.</comment>
111 |                 </field>
112 |                 <field id="token" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="30" translate="label comment" type="text">
113 |                     <label>Token</label>
114 |                     <comment>Slack API token</comment>
115 |                 </field>
116 |                 <field id="channel" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="40" translate="label comment" type="text">
117 |                     <label>Channel</label>
118 |                     <comment>Slack channel (encoded ID or name)</comment>
119 |                 </field>
120 |                 <field id="username" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="50" translate="label comment" type="text">
121 |                     <label>Username</label>
122 |                     <comment>Name of a bot</comment>
123 |                 </field>
124 |                 <field id="use_attachment" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="60" translate="label comment" type="select">
125 |                     <label>Use attachment</label>
126 |                     <comment>Whether the message should be added to Slack as attachment (plain text otherwise)</comment>
127 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
128 |                 </field>
129 |                 <field id="icon_emoji" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="70" translate="label comment" type="text">
130 |                     <label>Icon emoji</label>
131 |                     <comment>The emoji name to use (or null)</comment>
132 |                 </field>
133 |                 <field id="bubble" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="80" translate="label comment" type="select">
134 |                     <label>Bubble</label>
135 |                     <comment>Whether the messages that are handled can bubble up the stack or not</comment>
136 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
137 |                 </field>
138 |                 <field id="use_short_attachment" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="90" translate="label comment" type="select">
139 |                     <label>Use short attachment</label>
140 |                     <comment>Whether the the context/extra messages added to Slack as attachments are in a short style</comment>
141 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
142 |                 </field>
143 |                 <field id="include_context_and_extra" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="100" translate="label comment" type="select">
144 |                     <label>Include context and extra</label>
145 |                     <comment>Whether the attachment should include context and extra data</comment>
146 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
147 |                 </field>
148 |             </group>
149 |             <group id="socket" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
150 |                 <label>Socket</label>
151 |                 <field id="is_enabled" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="5" translate="label" type="select">
152 |                     <label>Enabled</label>
153 |                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
154 |                 </field>
155 |                 <field id="endpoint" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label" type="text">
156 |                     <label>Endpoint</label>
157 |                 </field>
158 |                 <field id="level" showInDefault="1" showInStore="0" showInWebsite="0" sortOrder="10" translate="label comment" type="select">
159 |                     <label>Level</label>
160 |                     <source_model>Opengento\Logger\Config\Source\LoggingLevel</source_model>
161 |                     <comment>Messages of this or a higher level will be logged in your log system.</comment>
162 |                 </field>
163 |             </group>
164 |         </section>
165 |     </system>
166 | </config>
167 | 


--------------------------------------------------------------------------------
/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © Magento, Inc. All rights reserved.
 5 |  * See COPYING.txt for license details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
10 |     <default>
11 |         <loggin>
12 |             <console>
13 |                 <level>100</level>
14 |                 <is_enabled>0</is_enabled>
15 |             </console>
16 |             <file>
17 |                 <is_enabled>0</is_enabled>
18 |                 <max_files>3</max_files>
19 |                 <filename>logger.log</filename>
20 |                 <level>100</level>
21 |             </file>
22 |             <mail>
23 |                 <is_enabled>0</is_enabled>
24 |                 <level>500</level>
25 |                 <subject>Opengento Logger is talking</subject>
26 |             </mail>
27 |             <slack>
28 |                 <is_enabled>0</is_enabled>
29 |                 <level>500</level>
30 |                 <use_attachment>1</use_attachment>
31 |                 <bubble>1</bubble>
32 |                 <use_short_attachment>0</use_short_attachment>
33 |                 <include_content_and_extra>0</include_content_and_extra>
34 |             </slack>
35 |             <socket>
36 |                 <is_enabled>0</is_enabled>
37 |                 <level>500</level>
38 |                 <endpoint/>
39 |             </socket>
40 |         </loggin>
41 |     </default>
42 | </config>
43 | 


--------------------------------------------------------------------------------
/etc/di.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <!--
  3 | /**
  4 |  * Copyright © OpenGento, All rights reserved.
  5 |  * See LICENSE bundled with this library for license details.
  6 |  */
  7 | -->
  8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
  9 | 
 10 |     <virtualType name="GelfTransport" type="Opengento\Logger\Transport\UdpTransportWrapper">
 11 |         <arguments>
 12 |             <argument name="hostPath" xsi:type="string">loggin/gelf/transport_host</argument>
 13 |             <argument name="portPath" xsi:type="string">loggin/gelf/transport_port</argument>
 14 |         </arguments>
 15 |     </virtualType>
 16 | 
 17 |     <virtualType name="GelfPublisher" type="Gelf\Publisher">
 18 |         <arguments>
 19 |             <argument name="transport" xsi:type="object">GelfTransport</argument>
 20 |         </arguments>
 21 |     </virtualType>
 22 | 
 23 |     <virtualType name="GelfHandler" type="Opengento\Logger\Handler\GelfHandler">
 24 |         <arguments>
 25 |             <argument name="isEnabled" xsi:type="string">loggin/gelf/is_enabled</argument>
 26 |             <argument name="levelPath" xsi:type="string">loggin/gelf/level</argument>
 27 |             <argument name="publisher" xsi:type="object">GelfPublisher</argument>
 28 |         </arguments>
 29 |     </virtualType>
 30 | 
 31 |     <virtualType name="MailHandler" type="Opengento\Logger\Handler\MailHandler">
 32 |         <arguments>
 33 |             <argument name="isEnabled" xsi:type="string">loggin/mail/is_enabled</argument>
 34 |             <argument name="levelPath" xsi:type="string">loggin/mail/level</argument>
 35 |             <argument name="toPath" xsi:type="string">loggin/mail/to</argument>
 36 |             <argument name="subjectPath" xsi:type="string">loggin/mail/subject</argument>
 37 |             <argument name="fromPath" xsi:type="string">loggin/mail/from</argument>
 38 |         </arguments>
 39 |     </virtualType>
 40 | 
 41 |     <virtualType name="ConsoleHandler" type="Opengento\Logger\Handler\ConsoleHandler">
 42 |         <arguments>
 43 |             <argument name="isEnabled" xsi:type="string">loggin/console/is_enabled</argument>
 44 |             <argument name="levelPath" xsi:type="string">loggin/console/level</argument>
 45 |         </arguments>
 46 |     </virtualType>
 47 | 
 48 |     <virtualType name="RotatingFileHandler" type="Opengento\Logger\Handler\RotatingFileHandler">
 49 |         <arguments>
 50 |             <argument name="isEnabled" xsi:type="string">loggin/file/is_enabled</argument>
 51 |             <argument name="levelPath" xsi:type="string">loggin/file/level</argument>
 52 |             <argument name="filenamePath" xsi:type="string">loggin/file/filename</argument>
 53 |             <argument name="maxFilesPath" xsi:type="string">loggin/file/max_files</argument>
 54 |         </arguments>
 55 |     </virtualType>
 56 | 
 57 |     <virtualType name="SlackHandler" type="Opengento\Logger\Handler\SlackHandler">
 58 |         <arguments>
 59 |             <argument name="isEnabled" xsi:type="string">loggin/slack/is_enabled</argument>
 60 |             <argument name="levelPath" xsi:type="string">loggin/slack/level</argument>
 61 |             <argument name="tokenPath" xsi:type="string">loggin/slack/token</argument>
 62 |             <argument name="channelPath" xsi:type="string">loggin/slack/channel</argument>
 63 |             <argument name="usernamePath" xsi:type="string">loggin/slack/username</argument>
 64 |             <argument name="useAttachmentPath" xsi:type="string">loggin/slack/use_attachment</argument>
 65 |             <argument name="iconEmojiPath" xsi:type="string">loggin/slack/icon_emoji</argument>
 66 |             <argument name="bubblePath" xsi:type="string">loggin/slack/bubble</argument>
 67 |             <argument name="useShortAttachmentPath" xsi:type="string">loggin/slack/use_short_attachment</argument>
 68 |             <argument name="includeContextAndExtraPath" xsi:type="string">loggin/slack/include_context_and_extra
 69 |             </argument>
 70 |         </arguments>
 71 |     </virtualType>
 72 | 
 73 |     <virtualType name="SocketHandler" type="Opengento\Logger\Handler\SocketHandler">
 74 |         <arguments>
 75 |             <argument name="isEnabled" xsi:type="string">loggin/socket/is_enabled</argument>
 76 |             <argument name="endpoint" xsi:type="string">loggin/socket/endpoint</argument>
 77 |             <argument name="levelPath" xsi:type="string">loggin/socket/level</argument>
 78 |         </arguments>
 79 |     </virtualType>
 80 | 
 81 |     <type name="Monolog\Logger">
 82 |         <arguments>
 83 |             <argument name="processors" xsi:type="array">
 84 |                 <item name="exceptions" xsi:type="object">Opengento\Logger\Processor\ExceptionProcessor</item>
 85 |                 <item name="custom_context" xsi:type="object">Opengento\Logger\Processor\CustomContextProcessor</item>
 86 |             </argument>
 87 |         </arguments>
 88 |         <plugin name="override_set_handlers_method"
 89 |                 type="Opengento\Logger\Plugin\MonologPlugin"
 90 |                 sortOrder="1" />
 91 |     </type>
 92 | 
 93 |     <type name="Opengento\Logger\Plugin\MonologPlugin">
 94 |         <arguments>
 95 |             <argument name="magentoHandlers" xsi:type="array">
 96 |                 <item name="gelf" xsi:type="object">GelfHandler</item>
 97 |                 <item name="mail" xsi:type="object">MailHandler</item>
 98 |                 <item name="console" xsi:type="object">ConsoleHandler</item>
 99 |                 <item name="logs" xsi:type="object">RotatingFileHandler</item>
100 |                 <item name="slack" xsi:type="object">SlackHandler</item>
101 |                 <item name="socket" xsi:type="object">SocketHandler</item>
102 |             </argument>
103 |         </arguments>
104 |     </type>
105 | </config>
106 | 


--------------------------------------------------------------------------------
/etc/module.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <!--
 3 | /**
 4 |  * Copyright © OpenGento, All rights reserved.
 5 |  * See LICENSE bundled with this library for license details.
 6 |  */
 7 | -->
 8 | <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 9 |         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
10 |     <module name="Opengento_Logger">
11 |     </module>
12 | </config>
13 | 


--------------------------------------------------------------------------------
/i18n/fr_FR.csv:
--------------------------------------------------------------------------------
1 | "Enabled ?", "Activé ?"
2 | "Gelf transport host", "Gelf transport host"
3 | "Gelf transport port", "Gelf transport port"
4 | "Custom configuration", "Configuration personnalisée"
5 | "Add key with custom value", "Ajoute une clé avec des valeurs personnalisées"
6 | "Logger key", "Logger key"
7 | "Logger value", "Logger value"
8 | 


--------------------------------------------------------------------------------
/registration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Copyright © OpenGento, All rights reserved.
 4 |  * See LICENSE bundled with this library for license details.
 5 |  */
 6 | 
 7 | declare(strict_types=1);
 8 | 
 9 | use Magento\Framework\Component\ComponentRegistrar;
10 | 
11 | ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Opengento_Logger', __DIR__);
12 | 


--------------------------------------------------------------------------------