EventLogLogger. Логгер в журнал событий.

Author: ProklUng

DependencyInjection/BitrixOrdinaryToolsExtension.php

@@ -33,6 +33,7 @@ public function load(array $configs, ContainerBuilder $container) : void
         $loader->load('services.yaml');
         $loader->load('seo.yaml');
         $loader->load('image_resizer.yaml');
+        $loader->load('loggers.yaml');
 
         if (!class_exists('Prokl\CustomFrameworkExtensionsBundle\DependencyInjection\CustomFrameworkExtensionsExtension')) {
             throw new LogicException(

Resources/config/loggers.yaml

@@ -0,0 +1,17 @@
+###########
+# Логгеры
+###########
+
+services:
+  # конфигурация по умолчанию в *этом* файле
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: true
+
+  bitrix_ordinary_tools.logger_event_table:
+    class: Prokl\BitrixOrdinaryToolsBundle\Services\Logger\EventLogLogger
+    tags:
+      - { name: monolog.logger }
+
+  Prokl\BitrixOrdinaryToolsBundle\Services\Logger\EventLogLogger: '@bitrix_ordinary_tools.logger_event_table'

Services/Logger/EventLogLogger.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Prokl\BitrixOrdinaryToolsBundle\Services\Logger;
+
+use Bitrix\Main\Application;
+use Bitrix\Main\EventLog\Internal\EventLogTable;
+use Bitrix\Main\Type\DateTime;
+use Monolog\Handler\AbstractProcessingHandler;
+use Monolog\Logger;
+
+/**
+ * Class EventLogLogger
+ * Записывает логи в журнал событий /bitrix/admin/event_log.php?lang=ru.
+ * @package Prokl\BitrixOrdinaryToolsBundle\Services\Logger
+ */
+class EventLogLogger extends AbstractProcessingHandler
+{
+    /**
+     * @var string
+     */
+    private $defaultModuleId;
+
+    /**
+     * @inheritdoc
+     */
+    public function __construct($level = Logger::DEBUG, string $moduleId = '')
+    {
+        parent::__construct($level);
+
+        $this->defaultModuleId = $moduleId;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function write(array $record): void
+    {
+        global $USER;
+        $appContext = Application::getInstance()->getContext();
+        $server = $appContext->getServer();
+
+        /** @var \DateTime $datetime */
+        $datetime = $record['datetime'];
+
+        EventLogTable::add([
+            'TIMESTAMP_X' => DateTime::createFromTimestamp($datetime->getTimestamp()),
+            'SEVERITY' => $record['level_name'],
+            'MODULE_ID' => $record['context']['MODULE_ID'] ?? $this->defaultModuleId,
+            'AUDIT_TYPE_ID' => $record['level_name'],
+            'ITEM_ID' => $record['context']['ITEM_ID'] ?? '',
+            'REMOTE_ADDR' => $record['context']['REMOTE_ADDR'] ?? $server->getRemoteAddr(),
+            'USER_AGENT' => $record['context']['USER_AGENT'] ?? $server->getUserAgent(),
+            'REQUEST_URI' => $record['context']['REQUEST_URI'] ?? $server->getRequestUri(),
+            'SITE_ID' => $record['context']['SITE_ID'] ?? $appContext->getSite(),
+            'USER_ID' => $record['context']['USER_ID'] ?? $USER->GetID(),
+            'GUEST_ID' => $record['context']['GUEST_ID'] ?? '',
+            'DESCRIPTION' => $this->interpolate($record['formatted'], (array)$record['context']),
+        ]);
+    }
+
+    /**
+     * @param string $message
+     * @param array  $context
+     *
+     * @return string
+     */
+    public function interpolate(string $message, array $context = []): string
+    {
+        // build a replacement array with braces around the context keys
+        $replace = [];
+        foreach ($context as $key => $val) {
+            // check that the value can be cast to string
+            if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
+                $replace['{' . $key . '}'] = $val;
+            }
+        }
+
+        // interpolate replacement values into the message and return
+        return strtr($message, $replace);
+    }
+}

composer.json

@@ -25,7 +25,8 @@
         "symfony/http-kernel": "^4.0 || ^5.0",
         "symfony/config": "~4|~5",
         "intervention/image": "^2.5",
-        "twig/twig": "~1.0 | ~2.0"
+        "twig/twig": "~1.0 | ~2.0",
+        "monolog/monolog": "~1.22 || ~2.0"
     },
     "require-dev": {
         "proklung/bitrix-phpunit-testing-tools": "^1.0"

readme.MD

@@ -42,4 +42,32 @@ composer require proklung/bitrix-tools-pack-bundle
 - `Prokl\BitrixOrdinaryToolsBundle\Services\Facades\CUser` - `CUser`
 - `Prokl\BitrixOrdinaryToolsBundle\Services\Facades\CUser` - `CFile`
 - `Prokl\BitrixOrdinaryToolsBundle\Services\Facades\EventManager` - `Bitrix\Main\EventManager`
-- `Prokl\BitrixOrdinaryToolsBundle\Services\Facades\EventMail` - `Bitrix\Main\Mail\Event`
+- `Prokl\BitrixOrdinaryToolsBundle\Services\Facades\EventMail` - `Bitrix\Main\Mail\Event`
+
+## Логгеры
+
+- `Prokl\BitrixOrdinaryToolsBundle\Services\Logger\EventLogLogger` - monolog-логгер для записи логов 
+в журнал событий /bitrix/admin/event_log.php?lang=ru.
+
+Конфигурация Monolog Bundle:
+
+```yaml
+monolog:
+  handlers:
+    myHandler:
+      type: service
+      id:  Prokl\BitrixOrdinaryToolsBundle\Services\Logger\EventLogLogger
+      level: error
+```
+
+Использование:
+
+```php
+        use Monolog\Logger;
+        /** @var Logger $logger */
+        $logger = container()->get('public_logger');
+        $logger->error(
+            'Testing',
+            ['context' => 'OK', 'MODULE_ID' => 'My module', 'ITEM_ID' => get_class($this)]
+        );
+```