Logging improvements

Model/Cache/InvalidateLogger.php

@@ -8,27 +8,93 @@
 
 namespace Magento\CloudComponents\Model\Cache;
 
+use Magento\Framework\App\Request\Http as HttpRequest;
+use Psr\Log\LoggerInterface as Logger;
+use Magento\CloudComponents\Model\DebugTrace;
+
 /**
  * Log cache invalidation to a file
  */
 class InvalidateLogger extends \Magento\Framework\Cache\InvalidateLogger
 {
+    /**
+     * @var string[]
+     */
+    private $tagsToLog = [
+        'cat_p',
+        'cat_c',
+        'PRODUCT_PRICE',
+        'cms_b',
+        'cms_p',
+        'config_scopes',
+        'eav',
+        'eav_attribute',
+        'fpc',
+        'review_block',
+        'SEARCH_QUERY',
+        'search_query',
+        'store_group',
+        'store',
+        'store_relations',
+        'website',
+        'CORE_DESIGN',
+        'core_design',
+        'WEBSERVICE',
+        'webservice',
+        'banner',
+        'catalog_event',
+        'config',
+        'block_html',
+        'COLLECTION_DATA',
+        'collection_data',
+        'collections',
+        'layout_general_cache_tag',
+        'layout',
+        'compiled_config',
+        'acl_cache',
+        'reflection',
+        'db_ddl',
+        'all'
+    ];
+
+    /**
+     * @var DebugTrace
+     */
+    private $debugTrace;
+
+    /**
+     * @param HttpRequest $request
+     * @param Logger $logger
+     * @param DebugTrace $debugTrace
+     */
+    public function __construct(
+        HttpRequest $request,
+        Logger $logger,
+        DebugTrace $debugTrace
+    ) {
+        parent::__construct($request, $logger);
+        $this->debugTrace = $debugTrace;
+    }
+
     /**
      * Log cache invalidation to a file
      *
      * @param mixed $invalidateInfo
      */
     public function execute($invalidateInfo)
     {
-        if (is_array($invalidateInfo)) {
-            $invalidateInfo['trace'] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-        } elseif (is_string($invalidateInfo)) {
-            $invalidateInfo = [
-                'main' => $invalidateInfo,
-                'trace' => debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)
-            ];
-        }
+        $needTrace = false;
+        if (is_array($invalidateInfo) && isset($invalidateInfo['tags'])) {
+            foreach ($invalidateInfo['tags'] as $tag) {
+                if (in_array(strtolower($tag), $this->tagsToLog)) {
+                    $needTrace = true;
+                }
+            }
 
+            if ($needTrace) {
+                $invalidateInfo['trace'] = $this->debugTrace->getTrace();
+            }
+        }
         parent::execute($invalidateInfo);
     }
 }

Model/DebugTrace.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model;
+
+/**
+ * Class to get compressed debug back trace
+ */
+class DebugTrace
+{
+    /**
+     * List of useless classes
+     *
+     * @var string[]
+     */
+    private $notAllowedClasses = [
+        'Symfony\Component\Console\Application',
+        'Magento\Framework\Console\Cli',
+        'Symfony\Component\Console\Command\Command',
+        'Magento\Staging\Model\Event\Manager\Proxy',
+        'Magento\Staging\Model\Event\Manager',
+        'Magento\Framework\Event\Invoker\InvokerDefault',
+        'Magento\CloudComponents\Model\Observer\CacheFlushAll',
+        'Magento\CloudComponents\Model\Cache\InvalidateLogger',
+        'Magento\CloudComponents\Model\Cache\InvalidateLogger',
+        'Magento\CloudComponents\Model\Indexation\Logger',
+        'Magento\Framework\Cache\Frontend\Decorator\Logger',
+        'Magento\Framework\Cache\Frontend\Decorator\Bare',
+        'Magento\Framework\App\Cache\Type\AccessProxy',
+        'Magento\Framework\Cache\Frontend\Decorator\TagScope',
+        'Magento\Framework\ObjectManager\ObjectManager',
+        'Magento\Framework\ObjectManager\Config\Compiled',
+        'Magento\Framework\ObjectManager\Config\Config',
+        'Magento\Framework\ObjectManager\Factory\Dynamic\Developer',
+        'Magento\Framework\ObjectManager\Factory\Dynamic\Production'
+    ];
+
+    /**
+     * List of useless functions
+     *
+     * @var string[]
+     */
+    private $notAllowedFunctions = [
+        '___callPlugins',
+        '___callParent',
+        'Magento\Framework\Interception\{closure}'
+    ];
+
+    /**
+     * Returns debug back trace
+     *
+     * @return array
+     */
+    public function getTrace()
+    {
+        $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+        foreach ($trace as $index => $line) {
+            if (!isset($line['function'], $line['class'], $line['file'])) {
+                continue;
+            }
+            if (in_array($line['function'], $this->notAllowedFunctions)
+                || in_array($line['class'], $this->notAllowedClasses)
+                || strpos($line['file'], 'Interceptor.php') !== false
+            ) {
+                unset($trace[$index]);
+            }
+            unset($trace[$index]['type']);
+        }
+
+        if (function_exists('gzcompress')) {
+            return bin2hex(
+                gzcompress(
+                    print_r(
+                        $trace,
+                        true
+                    )
+                )
+            );
+        }
+        return $trace;
+    }
+}

Model/Indexation/Logger.php

@@ -8,6 +8,7 @@
 
 namespace Magento\CloudComponents\Model\Indexation;
 
+use Magento\CloudComponents\Model\DebugTrace;
 use Magento\Framework\Indexer\ActionInterface;
 use Psr\Log\LoggerInterface;
 
@@ -21,12 +22,21 @@ class Logger
      */
     private $logger;
 
+    /**
+     * @var DebugTrace
+     */
+    private $debugTrace;
+
     /**
      * @param LoggerInterface $logger
+     * @param DebugTrace $debugTrace
      */
-    public function __construct(LoggerInterface $logger)
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        DebugTrace $debugTrace
+    ) {
         $this->logger = $logger;
+        $this->debugTrace = $debugTrace;
     }
 
     /**
@@ -39,7 +49,7 @@ public function afterExecuteFull(ActionInterface $subject)
         $this->logger->debug(
             'full_indexation: ' . get_class($subject),
             [
-                'trace' => debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)
+                'trace' => $this->debugTrace->getTrace()
             ]
         );
     }