[MetricsPower] Added ContextExtractor for logger

[MetricsPower] Added ContextExtractor for logger

.github/workflows/build.yml

@@ -32,12 +32,9 @@ jobs:
     strategy:
       matrix:
         php:
-          - "8.1"
           - "8.2"
           - "8.3"
         include:
-          - php-version: "8.1"
-            composer-options: "--ignore-platform-reqs"
           - php-version: "8.2"
             composer-options: "--ignore-platform-reqs"
           - php-version: "8.3"

Attribute/LoggerOptions.php

@@ -16,4 +16,14 @@
 namespace FRZB\Component\MetricsPower\Attribute;
 
 #[\Attribute(\Attribute::TARGET_CLASS)]
-final class LoggerOptions implements OptionsInterface {}
+final class LoggerOptions implements OptionsInterface
+{
+    public function __construct(
+        public readonly bool $isSerializable = true,
+    ) {}
+
+    public function isSerializable(): bool
+    {
+        return $this->isSerializable;
+    }
+}

Attribute/OptionsInterface.php

@@ -15,4 +15,7 @@
 
 namespace FRZB\Component\MetricsPower\Attribute;
 
-interface OptionsInterface {}
+interface OptionsInterface
+{
+    public function isSerializable(): bool;
+}

Attribute/PrometheusOptions.php

@@ -15,8 +15,6 @@
 
 namespace FRZB\Component\MetricsPower\Attribute;
 
-use FRZB\Component\MetricsPower\Helper\MetricalHelper;
-
 #[\Attribute(\Attribute::TARGET_CLASS)]
 final class PrometheusOptions implements OptionsInterface
 {
@@ -28,7 +26,11 @@ public function __construct(
         public readonly string $help,
         public readonly array $labels,
         public readonly array $values,
-    ) {
-        $this->counterName = MetricalHelper::getCounterName($this);
+        public readonly bool $isSerializable = true,
+    ) {}
+
+    public function isSerializable(): bool
+    {
+        return $this->isSerializable;
     }
 }

Attribute/SentryOptions.php

@@ -21,5 +21,11 @@ final class SentryOptions implements OptionsInterface
     public function __construct(
         public readonly bool $waitRetry = true,
         public readonly bool $onHandleFlush = true,
+        public readonly bool $isSerializable = true,
     ) {}
+
+    public function isSerializable(): bool
+    {
+        return $this->isSerializable;
+    }
 }

Handler/MetricsHandler.php

@@ -35,9 +35,9 @@ public function handle(AbstractWorkerMessageEvent|SendMessageToTransportsEvent $
         foreach (MetricalHelper::getOptions($event->getEnvelope()->getMessage()) as $option) {
             try {
                 $this->locator->get($option)($event, $option);
-                $this->logger->logInfo($event, $option);
+                $this->logger->info($event, $option);
             } catch (\Throwable $e) {
-                $this->logger->logError($event, $option, $e);
+                $this->logger->error($event, $option, $e);
             }
         }
     }

Logger/ContextExtractor/ContextExtractorInterface.php

@@ -0,0 +1,37 @@
+<?php
+
+/** @noinspection PhpDocSignatureInspection */
+
+declare(strict_types=1);
+
+/**
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ *
+ * Copyright (c) 2024 Mykhailo Shtanko fractalzombie@gmail.com
+ *
+ * For the full copyright and license information, please view the LICENSE.MD
+ * file that was distributed with this source code.
+ */
+
+namespace FRZB\Component\MetricsPower\Logger\ContextExtractor;
+
+use FRZB\Component\MetricsPower\Attribute\OptionsInterface;
+use FRZB\Component\MetricsPower\Logger\Data\Context;
+
+/**
+ * @template TTarget of mixed
+ * @template TOptions of OptionsInterface
+ */
+interface ContextExtractorInterface
+{
+    /**
+     * @param TTarget $target
+     * @param TOptions $options
+     * @param ?\Throwable $exception
+     */
+    public function extract(mixed $target, ?OptionsInterface $options = null, ?\Throwable $exception = null): Context;
+
+    public static function getType(): string;
+}

Logger/ContextExtractor/DefaultContextExtractor.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ *
+ * Copyright (c) 2024 Mykhailo Shtanko fractalzombie@gmail.com
+ *
+ * For the full copyright and license information, please view the LICENSE.MD
+ * file that was distributed with this source code.
+ */
+
+namespace FRZB\Component\MetricsPower\Logger\ContextExtractor;
+
+use FRZB\Component\DependencyInjection\Attribute\AsService;
+use FRZB\Component\DependencyInjection\Attribute\AsTagged;
+use FRZB\Component\MetricsPower\Attribute\OptionsInterface;
+use FRZB\Component\MetricsPower\Helper\ClassHelper;
+use FRZB\Component\MetricsPower\Logger\Data\Context;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @implements ContextExtractorInterface<object, OptionsInterface>
+ */
+#[AsService, AsTagged(ContextExtractorInterface::class)]
+class DefaultContextExtractor implements ContextExtractorInterface
+{
+    public const DEFAULT_TYPE = 'Default';
+    private const MESSAGE_INFO = '[MetricsPower] [INFO] [MESSAGE: Operation succeed] [OPTIONS_CLASS: {options_class}] [TARGET_CLASS: {target_class}]';
+    private const MESSAGE_ERROR = '[MetricsPower] [ERROR] [MESSAGE: Operation failed] [OPTIONS_CLASS: {options_class}] [MESSAGE_CLASS: {message_class}] [EXCEPTION_CLASS: {exception_class}] [EXCEPTION_MESSAGE: {exception_message}] [OPTIONS_VALUES: {option_values}]';
+
+    public function __construct(
+        private readonly SerializerInterface $serializer,
+    ) {}
+
+    public function extract(mixed $target, ?OptionsInterface $options = null, ?\Throwable $exception = null): Context
+    {
+        $message = $exception ? self::MESSAGE_ERROR : self::MESSAGE_INFO;
+        $context = ['target_class' => ClassHelper::getShortName($target)];
+
+        if ($options?->isSerializable()) {
+            $context += ['target_values' => $this->serializer->serialize($target, JsonEncoder::FORMAT)];
+        }
+
+        if ($options) {
+            $context += [
+                'options_class' => ClassHelper::getShortName($options),
+                'option_values' => ClassHelper::getProperties($options),
+            ];
+        }
+
+        if ($exception) {
+            $context += [
+                'exception_class' => ClassHelper::getShortName($exception),
+                'exception_message' => $exception->getMessage(),
+                'exception_trace' => $exception->getTrace(),
+            ];
+        }
+
+        return new Context($message, $context);
+    }
+
+    public static function getType(): string
+    {
+        return self::DEFAULT_TYPE;
+    }
+}

Logger/ContextExtractor/ExceptionEventContextExtractor.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ *
+ * Copyright (c) 2024 Mykhailo Shtanko fractalzombie@gmail.com
+ *
+ * For the full copyright and license information, please view the LICENSE.MD
+ * file that was distributed with this source code.
+ */
+
+namespace FRZB\Component\MetricsPower\Logger\ContextExtractor;
+
+use FRZB\Component\DependencyInjection\Attribute\AsService;
+use FRZB\Component\DependencyInjection\Attribute\AsTagged;
+use FRZB\Component\MetricsPower\Attribute\OptionsInterface;
+use FRZB\Component\MetricsPower\Helper\ClassHelper;
+use FRZB\Component\MetricsPower\Logger\Data\Context;
+use Symfony\Component\HttpKernel\Event\ExceptionEvent;
+
+/**
+ * @implements ContextExtractorInterface<ExceptionEvent, OptionsInterface>
+ */
+#[AsService, AsTagged(ContextExtractorInterface::class)]
+class ExceptionEventContextExtractor implements ContextExtractorInterface
+{
+    private const MESSAGE = '[MetricsPower] [ERROR] [MESSAGE: Operation failed] [TARGET_CLASS: {target_class}] [EXCEPTION_CLASS: {exception_class}] [EXCEPTION_MESSAGE: {exception_message}]';
+
+    public function extract(mixed $target, ?OptionsInterface $options = null, ?\Throwable $exception = null): Context
+    {
+        $context = [
+            'target_class' => ClassHelper::getShortName($target),
+        ];
+
+        if ($exception) {
+            $context += [
+                'exception_class' => ClassHelper::getShortName($target->getThrowable()),
+                'exception_message' => $target->getThrowable()->getMessage(),
+                'exception_trace' => $target->getThrowable()->getTrace(),
+            ];
+        }
+
+        return new Context(self::MESSAGE, $context);
+    }
+
+    public static function getType(): string
+    {
+        return ExceptionEvent::class;
+    }
+}

Logger/ContextExtractor/SendMessageToTransportsEventContextExtractor.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ *
+ * Copyright (c) 2024 Mykhailo Shtanko fractalzombie@gmail.com
+ *
+ * For the full copyright and license information, please view the LICENSE.MD
+ * file that was distributed with this source code.
+ */
+
+namespace FRZB\Component\MetricsPower\Logger\ContextExtractor;
+
+use FRZB\Component\DependencyInjection\Attribute\AsService;
+use FRZB\Component\DependencyInjection\Attribute\AsTagged;
+use FRZB\Component\MetricsPower\Attribute\OptionsInterface;
+use FRZB\Component\MetricsPower\Helper\ClassHelper;
+use FRZB\Component\MetricsPower\Logger\Data\Context;
+use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @implements ContextExtractorInterface<SendMessageToTransportsEvent, OptionsInterface>
+ */
+#[AsService, AsTagged(ContextExtractorInterface::class)]
+class SendMessageToTransportsEventContextExtractor implements ContextExtractorInterface
+{
+    private const MESSAGE = '[MetricsPower] [INFO] [MESSAGE: Sent to transport] [OPTIONS_CLASS: {options_class}] [TARGET_CLASS: {target_class}] [MESSAGE_CLASS: {message_class}]';
+
+    public function __construct(
+        private readonly SerializerInterface $serializer,
+    ) {}
+
+    public function extract(mixed $target, ?OptionsInterface $options = null, ?\Throwable $exception = null): Context
+    {
+        $context = [
+            'target_class' => ClassHelper::getShortName($target),
+            'message_class' => ClassHelper::getShortName($target->getEnvelope()->getMessage()),
+        ];
+
+        if ($options?->isSerializable()) {
+            $context += ['message_values' => $this->serializer->serialize($target->getEnvelope()->getMessage(), JsonEncoder::FORMAT)];
+        }
+
+        if ($options) {
+            $context += [
+                'options_class' => ClassHelper::getShortName($options),
+            ];
+        }
+
+        return new Context(self::MESSAGE, $context);
+    }
+
+    public static function getType(): string
+    {
+        return SendMessageToTransportsEvent::class;
+    }
+}

Logger/ContextExtractor/WorkerMessageFailedEventContextExtractor.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ *
+ * Copyright (c) 2024 Mykhailo Shtanko fractalzombie@gmail.com
+ *
+ * For the full copyright and license information, please view the LICENSE.MD
+ * file that was distributed with this source code.
+ */
+
+namespace FRZB\Component\MetricsPower\Logger\ContextExtractor;
+
+use FRZB\Component\DependencyInjection\Attribute\AsService;
+use FRZB\Component\DependencyInjection\Attribute\AsTagged;
+use FRZB\Component\MetricsPower\Attribute\OptionsInterface;
+use FRZB\Component\MetricsPower\Helper\ClassHelper;
+use FRZB\Component\MetricsPower\Logger\Data\Context;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @implements ContextExtractorInterface<WorkerMessageFailedEvent, OptionsInterface>
+ */
+#[AsService, AsTagged(ContextExtractorInterface::class)]
+final class WorkerMessageFailedEventContextExtractor implements ContextExtractorInterface
+{
+    private const MESSAGE = '[MetricsPower] [ERROR] [MESSAGE: Handle failed] [TARGET_CLASS: {target_class}] [OPTIONS_CLASS: {options_class}] [MESSAGE_CLASS: {message_class}] [EXCEPTION_CLASS: {exception_class}] [EXCEPTION_MESSAGE: {exception_message}] [OPTIONS_VALUES: {option_values}]';
+
+    public function __construct(
+        private readonly SerializerInterface $serializer,
+    ) {}
+
+    public function extract(mixed $target, ?OptionsInterface $options = null, ?\Throwable $exception = null): Context
+    {
+        $context = [
+            'target_class' => ClassHelper::getShortName($target),
+        ];
+
+        if ($options?->isSerializable()) {
+            $context += ['target_values' => $this->serializer->serialize($target->getEnvelope()->getMessage(), JsonEncoder::FORMAT)];
+        }
+
+        if ($options) {
+            $context += [
+                'options_class' => ClassHelper::getShortName($options),
+                'option_values' => ClassHelper::getProperties($options),
+            ];
+        }
+
+        if ($exception) {
+            $context += [
+                'exception_class' => ClassHelper::getShortName($exception),
+                'exception_message' => $exception->getMessage(),
+                'exception_trace' => $exception->getTrace(),
+            ];
+        }
+
+        return new Context(self::MESSAGE, $context);
+    }
+
+    public static function getType(): string
+    {
+        return WorkerMessageFailedEvent::class;
+    }
+}