3 namespace Friendica\Factory;
5 use Friendica\Core\Config\Configuration;
6 use Friendica\Core\Logger;
7 use Friendica\Network\HTTPException\InternalServerErrorException;
8 use Friendica\Util\Logger\FriendicaDevelopHandler;
9 use Friendica\Util\Logger\Introspection;
10 use Friendica\Util\Logger\SyslogLogger;
11 use Friendica\Util\Logger\WorkerLogger;
12 use Friendica\Util\Profiler;
14 use Psr\Log\LoggerInterface;
20 * Currently only Monolog is supported
25 * A list of classes, which shouldn't get logged
28 private static $ignoreClassList = [
35 * Creates a new PSR-3 compliant logger instances
37 * @param string $channel The channel of the logger instance
38 * @param Configuration $config The config
40 * @return LoggerInterface The PSR-3 compliant logger instance
41 * @throws InternalServerErrorException
43 public static function create($channel, Configuration $config)
45 $introspector = new Introspection(LogLevel::DEBUG, self::$ignoreClassList);
46 switch ($config->get('system', 'logger_adapter', 'monolog')) {
48 $level = $config->get('system', 'loglevel');
50 $logger = new SyslogLogger($channel, $introspector, $level);
54 $loggerTimeZone = new \DateTimeZone('UTC');
55 Monolog\Logger::setTimezone($loggerTimeZone);
57 $logger = new Monolog\Logger($channel);
58 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
59 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
60 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
61 $logger->pushProcessor($introspector);
63 $debugging = $config->get('system', 'debugging');
64 $stream = $config->get('system', 'logfile');
65 $level = $config->get('system', 'loglevel');
68 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
69 static::addStreamHandler($logger, $stream, $loglevel);
71 static::addVoidHandler($logger);
76 Logger::init($logger);
82 * Creates a new PSR-3 compliant develop logger
84 * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
85 * you'll use this logger instance for the duration of your work.
87 * It should never get filled during normal usage of Friendica
89 * @param string $channel The channel of the logger instance
90 * @param Configuration $config The config
92 * @return LoggerInterface The PSR-3 compliant logger instance
93 * @throws InternalServerErrorException
95 public static function createDev($channel, Configuration $config)
97 $debugging = $config->get('system', 'debugging');
98 $stream = $config->get('system', 'dlogfile');
99 $developerIp = $config->get('system', 'dlogip');
101 if (!isset($developerIp) || !$debugging) {
105 $loggerTimeZone = new \DateTimeZone('UTC');
106 Monolog\Logger::setTimezone($loggerTimeZone);
108 $logger = new Monolog\Logger($channel);
109 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
110 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
111 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
112 $logger->pushProcessor(new Introspection(LogLevel::DEBUG, self::$ignoreClassList));
114 $logger->pushHandler(new FriendicaDevelopHandler($developerIp));
116 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
118 Logger::setDevLogger($logger);
124 * Mapping a legacy level to the PSR-3 compliant levels
125 * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
127 * @param string $level the level to be mapped
129 * @return string the PSR-3 compliant level
131 private static function mapLegacyConfigDebugLevel($level)
136 return LogLevel::ERROR;
139 return LogLevel::WARNING;
142 return LogLevel::NOTICE;
145 return LogLevel::INFO;
148 return LogLevel::DEBUG;
151 return LogLevel::DEBUG;
152 // default if nothing set
159 * Adding a handler to a given logger instance
161 * @param LoggerInterface $logger The logger instance
162 * @param mixed $stream The stream which handles the logger output
163 * @param string $level The level, for which this handler at least should handle logging
167 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
168 * @throws \Exception in case of general failures
170 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
172 if ($logger instanceof Monolog\Logger) {
173 $loglevel = Monolog\Logger::toMonologLevel($level);
175 // fallback to notice if an invalid loglevel is set
176 if (!is_int($loglevel)) {
177 $loglevel = LogLevel::NOTICE;
180 $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
182 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
183 $fileHandler->setFormatter($formatter);
185 $logger->pushHandler($fileHandler);
187 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
191 public static function addVoidHandler($logger)
193 if ($logger instanceof Monolog\Logger) {
194 $logger->pushHandler(new Monolog\Handler\NullHandler());