ssch/t3-psr3-log-processor

Provide PSR-3 interpolate log processor

v1.0.0 2023-03-16 22:19 UTC

Requires

• php: ^7.4 || ^8.0
• typo3/cms-core: ^10.4 || ^11.5 || ^12.1

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.8
• phpstan/phpstan-phpunit: ^1.2
• phpstan/phpstan-strict-rules: ^1.4
• saschaegerer/phpstan-typo3: ^1.8
• symplify/easy-coding-standard: ^11.1
• typo3/testing-framework: ^6.16

Replaces

• typo3-ter/t3-psr3-log-processor: v1.0.0

GPL-2.0+

• Sebastian Schreiber

• logging
• typo3
• psr-3

README

https://www.php-fig.org/psr/psr-3/#12-message

Integration guide

The extension ships with a custom Processor to substitute log messages with context variables in the message. Let´s say you have a log message with the following format:

use Psr\Log\LogLevel;use TYPO3\CMS\Core\Log\LogRecord;

$logRecord = new LogRecord('foo', LogLevel::INFO, 'A message with a {placeholder}', ['placeholder' => 'bar']);

In that case the {placeholder} of the message will be substituted by "bar" when processed by the PsrLogProcessor shipped with the extension.

In order to activate the Processor you can configure it i.e. via ext_localconf.php

$GLOBALS['TYPO3_CONF_VARS']['LOG']['Documentation']['Examples']['Controller']['processorConfiguration'] = [
    // configuration for Debug level log entries and above
    \TYPO3\CMS\Core\Log\LogLevel::DEBUG => [
        \Ssch\Psr3LogProcessor\Processor\PsrLogMessageProcessor::class => [
            // The format of the timestamp: one supported by DateTime::format
            'dateFormat' => DateTime::ISO8601,
            // If set to true the fields interpolated into message gets unset
            'removeUsedContextFields' => true,
            // Arrays will be json encoded. With this option you can define how this will happen
            'jsonFlags' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE
        ]
    ]
];

https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Logging/Configuration/Index.html#processor-configuration

Credits

This LogProcessor is heavily inspired by the Processor of monolog/monolog