Skip to content

Add extra debug data to cache_invalidate log #40196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: 2.4-develop
Choose a base branch
from
Open

Add extra debug data to cache_invalidate log #40196

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9f2a297
Add extra debug data to `cache_invalidate` log
convenient Sep 18, 2025
2eb2086
Fix line length
convenient Sep 18, 2025
ba81047
Update copyright header
convenient Sep 18, 2025
1c02409
Update InvalidateLogger.php
convenient Oct 5, 2025
4b5df87
Merge branch '2.4-develop' into patch-3
convenient Oct 5, 2025
0b27837
Update InvalidateLogger.php
convenient Oct 5, 2025
f91f50f
Merge branch '2.4-develop' into patch-3
engcom-Hotel Oct 23, 2025
da7a211
Merge branch '2.4-develop' into patch-3
engcom-Dash Oct 27, 2025
7c032b5
Merge branch '2.4-develop' into patch-3
engcom-Dash Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions lib/internal/Magento/Framework/Cache/InvalidateLogger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<?php
/**
* Cache configuration model. Provides cache configuration data to the application
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
* Copyright 2015 Adobe
* All Rights Reserved.
*/
namespace Magento\Framework\Cache;

Expand Down Expand Up @@ -43,7 +41,18 @@ public function __construct(HttpRequest $request, Logger $logger)
*/
public function execute($invalidateInfo)
{
$this->logger->debug('cache_invalidate: ', $this->makeParams($invalidateInfo));
$context = $this->makeParams($invalidateInfo);
if (isset($invalidateInfo['tags'], $invalidateInfo['mode'])) {
if ($invalidateInfo['mode'] === 'all'
&& is_array($invalidateInfo['tags'])
&& empty($invalidateInfo['tags'])
) {
// If we are sending a purge request to all cache storage capture the trace
// This is not a usual flow, and likely a bug is causing a performance issue
$context['trace'] = (string)(new \Exception('full purge of cache storage triggered'));
}
}
$this->logger->debug('cache_invalidate: ', $context);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, if. you pass exception to psr log based on monolog in format like $this->logger->debug('cache_invalidate: ', ['exception'=> new \Exception()]); it will add trace to message

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh i didn't know that thanks. I've just given it a quick test like this to see

$this->logger->debug('cache_invalidate: ', ['exception'=> new \Exception()]);

and i get this log, it does the exception but without the full trace

main.DEBUG: cache_invalidate:  {"exception":"[object] (Exception(code: 0):  at /var/www/html/vendor/magento/framework/Cache/InvalidateLogger.php:54)"}

Am I missing a trick?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't speak to @kandy's message, but another option is casting the exception to string. That should give the message, code, and full formatted trace. (string)(new \Exception()) (see https://www.php.net/manual/en/exception.tostring.php)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhoerr that's decent, looks like this

public function execute($invalidateInfo)
{
    $context = $this->makeParams($invalidateInfo);
    if (isset($invalidateInfo['tags'], $invalidateInfo['mode'])) {
        if ($invalidateInfo['mode'] === 'all' && is_array($invalidateInfo['tags']) && empty($invalidateInfo['tags'])) {
            // If we are sending a purge request to all cache storage capture the trace
            // This is not a usual flow, and likely a bug is causing a performance issue
            $context['exception'] =  (string)(new \Exception('full purge of cache storage triggered'));
        }
    }
    $this->logger->debug('cache_invalidate: ', $context);
}
[2025-09-18T15:50:52.353321+00:00] main.DEBUG: cache_invalidate:  {"method":"GET","url":"http:/","invalidateInfo":{"tags":[],"mode":"all"},"exception":"Exception: full purge of cache storage triggered in /var/www/html/vendor/magento/framework/Cache/InvalidateLogger.php:51
Stack trace:
#0 /var/www/html/vendor/magento/framework/Cache/Frontend/Decorator/Logger.php(60): Magento\\Framework\\Cache\\InvalidateLogger->execute(Array)
#1 /var/www/html/vendor/magento/framework/Cache/Frontend/Decorator/Logger.php(48): Magento\\Framework\\Cache\\Frontend\\Decorator\\Logger->log(Array)
#2 /var/www/html/vendor/magento/framework/App/Cache.php(102): Magento\\Framework\\Cache\\Frontend\\Decorator\\Logger->clean()
#3 /var/www/html/vendor/magento/framework/App/Cache/Proxy.php(103): Magento\\Framework\\App\\Cache->clean(Array)
#4 /var/www/html/test.php(22): Magento\\Framework\\App\\Cache\\Proxy->clean(Array)
#5 {main}"} []

I'm happy with any approach really, so long as we get the full stack trace to work with. Can the adobe team please advise what they prefer :)

}

/**
Expand Down