[Test PR] SWAT-430: Extended debugging information about cache & indexer invalidation

Model/Cache/InvalidateLogger.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model\Cache;
+
+/**
+ * Log cache invalidation to a file
+ */
+class InvalidateLogger extends \Magento\Framework\Cache\InvalidateLogger
+{
+    /**
+     * Log cache invalidation to a file
+     *
+     * @param mixed $invalidateInfo
+     */
+    public function execute($invalidateInfo)
+    {
+        $invalidateInfo['trace'] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+        parent::execute($invalidateInfo);
+    }
+}

Model/Indexation/Logger.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model\Indexation;
+
+use Magento\Framework\Indexer\ActionInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Log full re-indexation to a file
+ */
+class Logger
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Log full re-indexation to a file
+     *
+     * @param ActionInterface $subject
+     */
+    public function afterExecuteFull(ActionInterface $subject)
+    {
+        $this->logger->debug(
+            'full_indexation: ' . get_class($subject),
+            [
+                'trace' => debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)
+            ]
+        );
+    }
+}

Model/Logger/Handler/Debug.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model\Logger\Handler;
+
+/**
+ * Debug handler which doesn't require debug mode enabled
+ */
+class Debug extends \Magento\Framework\Logger\Handler\Debug
+{
+    /**
+     * @param array $record
+     * @return mixed
+     */
+    public function isHandling(array $record)
+    {
+        return parent::isHandling($record);
+    }
+}

Model/Observer/CacheFlushAll.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model\Observer;
+
+use Magento\Framework\Event\Observer;
+use Magento\Framework\Event\ObserverInterface;
+use Magento\Framework\Cache\InvalidateLogger;
+
+/**
+ * Log cache flush action to a file
+ */
+class CacheFlushAll implements ObserverInterface
+{
+    /**
+     * @var InvalidateLogger
+     */
+    private $logger;
+
+    /**
+     * @param InvalidateLogger $logger
+     */
+    public function __construct(InvalidateLogger $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Log cache flush action to a file
+     *
+     * @param Observer $observer
+     */
+    public function execute(Observer $observer)
+    {
+        $this->logger->execute(['tags' => ['all']]);
+    }
+}

Model/Observer/IndexerStateSaveAfter.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\CloudComponents\Model\Observer;
+
+use Magento\Framework\Event\Observer;
+use Magento\Framework\Event\ObserverInterface;
+use Magento\Framework\Indexer\StateInterface;
+use Magento\Framework\Validator\Exception;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Log all indexers invalidations to a file
+ */
+class IndexerStateSaveAfter implements ObserverInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Log all indexers invalidations to a file
+     *
+     * @param Observer $observer
+     */
+    public function execute(Observer $observer)
+    {
+        $indexerState = $observer->getData('indexer_state');
+        if ($indexerState->getData('status') !== $indexerState->getOrigData('status')
+            && $indexerState->getData('status') === StateInterface::STATUS_INVALID
+        ) {
+            $this->logger->debug(
+                'indexer_invalidation: ' . $indexerState->getData('indexer_id'),
+                [
+                    'trace' => debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)
+                ]
+            );
+        }
+    }
+}

etc/di.xml

@@ -15,4 +15,56 @@
             </argument>
         </arguments>
     </type>
+
+    <!-- Log cache invalidation event to separate file -->
+    <type name="Magento\CloudComponents\Model\Logger\Handler\Debug">
+        <arguments>
+            <argument name="fileName" xsi:type="string">/var/log/cache.log</argument>
+        </arguments>
+    </type>
+    <virtualType name="Magento\CloudComponents\Model\Logger\CacheInvalidate" type="Magento\Framework\Logger\Monolog">
+        <arguments>
+            <argument name="name" xsi:type="string">main</argument>
+            <argument name="handlers"  xsi:type="array">
+                <item name="debug" xsi:type="object">Magento\CloudComponents\Model\Logger\Handler\Debug</item>
+            </argument>
+        </arguments>
+    </virtualType>
+    <type name="Magento\CloudComponents\Model\Cache\InvalidateLogger">
+        <arguments>
+            <argument name="logger" xsi:type="object">Magento\CloudComponents\Model\Logger\CacheInvalidate</argument>
+        </arguments>
+    </type>
+    <preference for="Magento\Framework\Cache\InvalidateLogger" type="Magento\CloudComponents\Model\Cache\InvalidateLogger"/>
+
+    <!-- Log full reindex action -->
+    <virtualType name="Magento\CloudComponents\Model\Logger\Handler\Debug\Indexation" type="Magento\CloudComponents\Model\Logger\Handler\Debug">
+        <arguments>
+            <argument name="fileName" xsi:type="string">/var/log/indexation.log</argument>
+        </arguments>
+    </virtualType>
+    <virtualType name="Magento\CloudComponents\Model\Logger\Monolog\Indexation" type="Magento\Framework\Logger\Monolog">
+        <arguments>
+            <argument name="name" xsi:type="string">main</argument>
+            <argument name="handlers"  xsi:type="array">
+                <item name="debug" xsi:type="object">Magento\CloudComponents\Model\Logger\Handler\Debug\Indexation</item>
+            </argument>
+        </arguments>
+    </virtualType>
+    <type name="Magento\CloudComponents\Model\Indexation\Logger">
+        <arguments>
+            <argument name="logger" xsi:type="object">Magento\CloudComponents\Model\Logger\Monolog\Indexation</argument>
+        </arguments>
+    </type>
+
+
+    <!-- Log Index invalidation action -->
+    <type name="Magento\CloudComponents\Model\Observer\IndexerStateSaveAfter">
+        <arguments>
+            <argument name="logger" xsi:type="object">Magento\CloudComponents\Model\Logger\Monolog\Indexation</argument>
+        </arguments>
+    </type>
+    <type name="Magento\Framework\Indexer\ActionInterface">
+        <plugin name="cache_cleaner_after_reindex" type="Magento\CloudComponents\Model\Indexation\Logger" />
+    </type>
 </config>

etc/events.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="indexer_state_save_after">
+        <observer name="log_indexer_invalidation_action" instance="Magento\CloudComponents\Model\Observer\IndexerStateSaveAfter" />
+    </event>
+    <event name="adminhtml_cache_flush_all">
+        <observer name="log_cache_flush_action" instance="Magento\CloudComponents\Model\Observer\CacheFlushAll" />
+    </event>
+</config>

registration.php

@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 use \Magento\Framework\Component\ComponentRegistrar;
 
 ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_CloudComponents', __DIR__);