Skip to content

Updated (monolog) logging #5148

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

Draft
sreichel wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

Updated (monolog) logging #5148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f544f17
moved log code to Mage_Core_Helper_Log
sreichel Dec 12, 2025
518828f
added unit tests
sreichel Dec 12, 2025
eec7e16
update
sreichel Dec 12, 2025
36cda5c
update tests
sreichel Dec 12, 2025
5682459
test comment
sreichel Dec 12, 2025
8a3e5bc
phpcsfixer
sreichel Dec 12, 2025
4ac92b2
Update app/code/core/Mage/Core/Helper/Log.php
sreichel Dec 12, 2025
5fed3e0
update
sreichel Dec 12, 2025
361c2d7
Merge remote-tracking branch 'origin/fix/monolog' into fix/monolog
sreichel Dec 12, 2025
6b49686
typo
sreichel Dec 12, 2025
077f113
typo
sreichel Dec 12, 2025
0d4d0d3
typo
sreichel Dec 12, 2025
50ae57a
types
sreichel Dec 12, 2025
bb815a5
use RFC5424 levels for compatibility
sreichel Dec 12, 2025
110963b
tests
sreichel Dec 12, 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
7 changes: 3 additions & 4 deletions .phpstorm.meta.php/magento_helpers.meta.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
namespace PHPSTORM_META {
override( \Mage::helper(0),
map( [
'mm_ignition' => \MM_Ignition_Helper_Data::class,
'mm_ignition/data' => \MM_Ignition_Helper_Data::class,
'mm_ignition/flare' => \MM_Ignition_Helper_Flare::class,
'mm_ignition/openAi' => \MM_Ignition_Helper_OpenAi::class,
'adminnotification' => \Mage_AdminNotification_Helper_Data::class,
'adminnotification/data' => \Mage_AdminNotification_Helper_Data::class,
'admin/block' => \Mage_Admin_Helper_Block::class,
Expand Down Expand Up @@ -96,6 +92,9 @@
'core/hint' => \Mage_Core_Helper_Hint::class,
'core/http' => \Mage_Core_Helper_Http::class,
'core/js' => \Mage_Core_Helper_Js::class,
'core/log' => \Mage_Core_Helper_Log::class,
'core/measure_length' => \Mage_Core_Helper_Measure_Length::class,
'core/measure_weight' => \Mage_Core_Helper_Measure_Weight::class,
'core/purifier' => \Mage_Core_Helper_Purifier::class,
'core/security' => \Mage_Core_Helper_Security::class,
'core/string' => \Mage_Core_Helper_String::class,
Expand Down
112 changes: 48 additions & 64 deletions .phpstorm.meta.php/magento_helpers_methods.meta.php
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 0 additions & 10 deletions .phpstorm.meta.php/magento_models.meta.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -3172,11 +3167,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down
45 changes: 0 additions & 45 deletions .phpstorm.meta.php/magento_models_methods.meta.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -3172,11 +3167,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -6336,11 +6326,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -9500,11 +9485,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -12664,11 +12644,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -15828,11 +15803,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -18992,11 +18962,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -22156,11 +22121,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down Expand Up @@ -25320,11 +25280,6 @@
'cm_redissession/session_config' => \Cm_RedisSession_Model_Session_Config::class,
'cm_redissession/session_handler' => \Cm_RedisSession_Model_Session_Handler::class,
'cm_redissession/session_logger' => \Cm_RedisSession_Model_Session_Logger::class,
'mm_ignition/observer_abstract' => \MM_Ignition_Model_Observer_Abstract::class,
'mm_ignition/observer_handleIgnitionException' => \MM_Ignition_Model_Observer_HandleIgnitionException::class,
'mm_ignition/observer_handleIgnitionRegister' => \MM_Ignition_Model_Observer_HandleIgnitionRegister::class,
'mm_ignition/system_config_source_editor' => \MM_Ignition_Model_System_Config_Source_Editor::class,
'mm_ignition/system_config_source_theme' => \MM_Ignition_Model_System_Config_Source_Theme::class,
'adminnotification/feed' => \Mage_AdminNotification_Model_Feed::class,
'adminnotification/inbox' => \Mage_AdminNotification_Model_Inbox::class,
'adminnotification/mysql4_inbox' => \Mage_AdminNotification_Model_Mysql4_Inbox::class,
Expand Down
5 changes: 5 additions & 0 deletions .rector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@
Php85\ArrayDimFetch\ArrayFirstLastRector::class,
])
->withConfiguredRule(RenameClassConstFetchRector::class, [
new RenameClassAndConstFetch('Mage_Core_Helper_Data', 'XML_PATH_DEV_LOG_ENABLED', 'Mage_Core_Helper_Log', 'XML_PATH_DEV_LOG_ENABLED'),
new RenameClassAndConstFetch('Mage_Core_Helper_Data', 'XML_PATH_DEV_LOG_ALLOWED_EXTENSIONS', 'Mage_Core_Helper_Log', 'XML_PATH_DEV_LOG_ALLOWED_EXTENSIONS'),
new RenameClassAndConstFetch('Mage_Core_Helper_Data', 'XML_PATH_DEV_LOG_FILE', 'Mage_Core_Helper_Log', 'XML_PATH_DEV_LOG_FILE'),
new RenameClassAndConstFetch('Mage_Core_Helper_Data', 'XML_PATH_DEV_LOG_EXCEPTION_FILE', 'Mage_Core_Helper_Log', 'XML_PATH_DEV_LOG_EXCEPTION_FILE'),
new RenameClassAndConstFetch('Mage_Core_Helper_Data', 'XML_PATH_DEV_LOG_MAX_LEVEL', 'Mage_Core_Helper_Log', 'XML_PATH_DEV_LOG_MAX_LEVEL'),
new RenameClassAndConstFetch('Zend_Log', 'EMERG', 'Monolog\Level', 'Emergency'),
new RenameClassAndConstFetch('Zend_Log', 'ALERT', 'Monolog\Level', 'Alert'),
new RenameClassAndConstFetch('Zend_Log', 'CRIT', 'Monolog\Level', 'Critical'),
Expand Down
59 changes: 19 additions & 40 deletions app/Mage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
* @package Mage
*/

use Monolog\Formatter\LineFormatter;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\FormattableHandlerInterface;
use Monolog\Level;
use Monolog\Logger;

Expand Down Expand Up @@ -885,9 +884,9 @@ public static function log($message, $level = null, $file = '', $forceLog = fals
}

try {
$logActive = self::getStoreConfigFlag(Mage_Core_Helper_Data::XML_PATH_DEV_LOG_ENABLED);
$logActive = self::getStoreConfigFlag(Mage_Core_Helper_Log::XML_PATH_DEV_LOG_ENABLED);
if (empty($file)) {
$file = self::getStoreConfig(Mage_Core_Helper_Data::XML_PATH_DEV_LOG_FILE);
$file = self::getStoreConfig(Mage_Core_Helper_Log::XML_PATH_DEV_LOG_FILE);
}
} catch (Exception) {
$logActive = true;
Expand All @@ -899,41 +898,19 @@ public static function log($message, $level = null, $file = '', $forceLog = fals

static $loggers = [];

try {
$maxLogLevel = self::getStoreConfigAsInt(Mage_Core_Helper_Data::XML_PATH_DEV_LOG_MAX_LEVEL);
} catch (Throwable) {
$maxLogLevel = Level::Debug->value;
}

// Normalize both $level and $maxLogLevel to integers for comparison
if ($level instanceof Level) {
$levelValue = $level->value;
} elseif (is_null($level)) {
$levelValue = Level::Debug->value;
} else {
$levelValue = (int) $level;
}
$maxLogLevel = Mage_Core_Helper_Log::getLogLevelMax();
$levelValue = Mage_Core_Helper_Log::getLogLevel($level);

if (!self::$_isDeveloperMode && $levelValue > $maxLogLevel && !$forceLog) {
return;
}

$file = empty($file)
? (string) self::getConfig()->getNode(
Mage_Core_Helper_Data::XML_PATH_DEV_LOG_FILE,
Mage_Core_Model_Store::DEFAULT_CODE,
) : basename($file);
$file = empty($file) ? Mage_Core_Helper_Log::getLogFile() : basename($file);

try {
if (!isset($loggers[$file])) {
// Validate file extension before save. Allowed file extensions: log, txt, html, csv
$_allowedFileExtensions = explode(
',',
(string) self::getConfig()->getNode(
Mage_Core_Helper_Data::XML_PATH_DEV_LOG_ALLOWED_EXTENSIONS,
Mage_Core_Model_Store::DEFAULT_CODE,
),
);
$_allowedFileExtensions = Mage_Core_Helper_Log::getAllowedFileExtensions();
if (! ($extension = pathinfo($file, PATHINFO_EXTENSION)) || ! in_array($extension, $_allowedFileExtensions)) {
return;
}
Expand All @@ -951,18 +928,20 @@ public static function log($message, $level = null, $file = '', $forceLog = fals
chmod($logFile, 0640);
}

$format = '%datetime% %level_name% (%level%): %message% %context% %extra%' . PHP_EOL;
$formatter = new LineFormatter($format, null, true, true, true);
$writerModel = (string) self::getConfig()->getNode('global/log/core/writer_model');
if (!self::$_app || !$writerModel) {
$writer = new StreamHandler($logFile, Level::Debug);
} else {
$writer = new $writerModel($logFile, Level::Debug);
$handler = Mage_Core_Helper_Log::getHandler(self::$_app, $logFile);

if ($handler instanceof FormattableHandlerInterface) {
$format = '%datetime% %level_name% (%level%): %message% %context% %extra%' . PHP_EOL;
$handler->setFormatter(Mage_Core_Helper_Log::getLineFormatter(
format: $format,
allowInlineLineBreaks: true,
ignoreEmptyContextAndExtra: true,
includeStacktraces: true,
));
}

$writer->setFormatter($formatter);
$logger = new Logger('OpenMage');
$logger->pushHandler($writer);
$logger->pushHandler($handler);
$loggers[$file] = $logger;
}

Expand All @@ -985,7 +964,7 @@ public static function logException(Throwable $e)
return;
}

$file = self::getStoreConfig(Mage_Core_Helper_Data::XML_PATH_DEV_LOG_EXCEPTION_FILE);
$file = self::getStoreConfig(Mage_Core_Helper_Log::XML_PATH_DEV_LOG_EXCEPTION_FILE);
self::log("\n" . $e->__toString(), Level::Error, $file);
}

Expand Down
Loading
Loading