Implement monolog addon as LoggerFactory #1598

Merged
MrPetovan merged 6 commits from Art4/friendica-addons:loggerfactory-in-monolog-addon into develop 2025-02-08 04:16:48 +01:00
5 changed files with 36 additions and 43 deletions

4
monolog/README.md Normal file
View file

@ -0,0 +1,4 @@
# Monolog Addon
A Logging framework with lots of additions (see [Monolog](https://github.com/Seldaek/monolog/)).
There are just Friendica additions inside the src directory.

View file

@ -1,7 +1,7 @@
<?php
/*
* Name: Monolog
* Description: A Logging framework with lots of additions (see [Monolog](https://github.com/Seldaek/monolog/)). There are just Friendica additions inside the src directory
* Version: 1.0
* Description: A Logging framework with lots of additions, customized for Friendica.
* Version: 1.1
* Author: Philipp Holzer
*/

View file

@ -4,7 +4,8 @@ namespace Friendica\Addon\monolog\src\Factory;
use Friendica\Addon\monolog\src\Monolog\IntrospectionProcessor;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\Core\Logger\Factory\AbstractLoggerTypeFactory;
use Friendica\Core\Logger\Capability\IHaveCallIntrospections;
use Friendica\Core\Logger\Factory\LoggerFactory;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
@ -16,32 +17,49 @@ use Psr\Log\LogLevel;
require_once __DIR__ . '/../../vendor/autoload.php';
class Monolog extends AbstractLoggerTypeFactory
final class MonologFactory implements LoggerFactory
{
public function create(IManageConfigValues $config, string $loglevel = null): LoggerInterface
private IHaveCallIntrospections $introspection;
private IManageConfigValues $config;
public function __construct(IHaveCallIntrospections $introspection, IManageConfigValues $config)
{
$this->introspection = $introspection;
$this->config = $config;
}
/**
* Creates and returns a PSR-3 Logger instance.
*
* Calling this method multiple times with the same parameters SHOULD return the same object.
*
* @param \Psr\Log\LogLevel::* $logLevel The log level
* @param \Friendica\Core\Logger\Capability\LogChannel::* $logChannel The log channel
*/
public function createLogger(string $logLevel, string $logChannel): LoggerInterface
{
$loggerTimeZone = new \DateTimeZone('UTC');
$logger = new Logger($this->channel);
$logger = new Logger($logChannel);
$logger->setTimezone($loggerTimeZone);
$logger->pushProcessor(new PsrLogMessageProcessor());
$logger->pushProcessor(new ProcessIdProcessor());
$logger->pushProcessor(new UidProcessor());
$logger->pushProcessor(new IntrospectionProcessor($this->introspection, LogLevel::DEBUG));
$logfile = $config->get('system', 'logfile');
$logfile = $this->config->get('system', 'logfile');
MrPetovan marked this conversation as resolved
Review

Why change the capitalization of $logLevel but not of $logfile?

Why change the capitalization of `$logLevel` but not of `$logfile`?
Review

$logLevel comes from the LoggerFactory interface, but I had no reason to change $logfile.

`$logLevel` comes from the `LoggerFactory` interface, but I had no reason to change `$logfile`.
// just add a stream in case it's either writable or not file
if (is_writable($logfile)) {
$loglevel = $loglevel ?? static::mapLegacyConfigDebugLevel($config->get('system', 'loglevel'));
$loglevel = Logger::toMonologLevel($loglevel);
$logLevel = Logger::toMonologLevel($logLevel);
// fallback to notice if an invalid loglevel is set
if (!is_int($loglevel)) {
$loglevel = LogLevel::NOTICE;
if (!is_int($logLevel)) {
$logLevel = LogLevel::NOTICE;
}
$fileHandler = new StreamHandler($logfile, $loglevel);
$fileHandler = new StreamHandler($logfile, $logLevel);
$formatter = new LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
$fileHandler->setFormatter($formatter);

View file

@ -20,10 +20,7 @@
*/
return [
\Monolog\Logger::class => [
'instanceOf' => \Friendica\Addon\monolog\src\Factory\Monolog::class,
'call' => [
['create', [], \Dice\Dice::CHAIN_CALL],
],
\Friendica\Core\Logger\Factory\LoggerFactory::class => [
'instanceOf' => \Friendica\Addon\monolog\src\Factory\MonologFactory::class,
],
];

View file

@ -1,26 +0,0 @@
<?php
/**
* @copyright Copyright (C) 2010-2023, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
return [
\Psr\Log\LoggerInterface::class => [
\Monolog\Logger::class => ['monolog'],
],
];