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\Introspection;
9 use Friendica\Util\Logger\Monolog\DevelopHandler;
10 use Friendica\Util\Logger\Monolog\IntrospectionProcessor;
11 use Friendica\Util\Logger\ProfilerLogger;
12 use Friendica\Util\Logger\StreamLogger;
13 use Friendica\Util\Logger\SyslogLogger;
14 use Friendica\Util\Logger\VoidLogger;
15 use Friendica\Util\Profiler;
17 use Psr\Log\LoggerInterface;
23 * Currently only Monolog is supported
28 * A list of classes, which shouldn't get logged
31 private static $ignoreClassList = [
34 'Friendica\\Util\\Logger',
38 * Creates a new PSR-3 compliant logger instances
40 * @param string $channel The channel of the logger instance
41 * @param Configuration $config The config
42 * @param Profiler $profiler The profiler of the app
44 * @return LoggerInterface The PSR-3 compliant logger instance
47 * @throws InternalServerErrorException
49 public static function create($channel, Configuration $config, Profiler $profiler)
51 if (empty($config->get('system', 'debugging', false))) {
52 $logger = new VoidLogger();
53 Logger::init($logger);
57 $introspection = new Introspection(self::$ignoreClassList);
58 $level = $config->get('system', 'loglevel');
59 $loglevel = self::mapLegacyConfigDebugLevel((string)$level);
61 switch ($config->get('system', 'logger_config', 'stream')) {
63 $loggerTimeZone = new \DateTimeZone('UTC');
64 Monolog\Logger::setTimezone($loggerTimeZone);
66 $logger = new Monolog\Logger($channel);
67 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
68 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
69 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
70 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
72 $stream = $config->get('system', 'logfile');
74 static::addStreamHandler($logger, $stream, $loglevel);
78 $logger = new SyslogLogger($channel, $introspection, $loglevel);
83 $stream = $config->get('system', 'logfile');
84 $logger = new StreamLogger($channel, $stream, $introspection, $loglevel);
88 $profiling = $config->get('system', 'profiling', false);
90 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
91 if (isset($profiling) && $profiling !== false) {
92 $logger = new ProfilerLogger($logger, $profiler);
95 Logger::init($logger);
101 * Creates a new PSR-3 compliant develop logger
103 * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
104 * you'll use this logger instance for the duration of your work.
106 * It should never get filled during normal usage of Friendica
108 * @param string $channel The channel of the logger instance
109 * @param Configuration $config The config
110 * @param Profiler $profiler The profiler of the app
112 * @return LoggerInterface The PSR-3 compliant logger instance
114 * @throws InternalServerErrorException
117 public static function createDev($channel, Configuration $config, Profiler $profiler)
119 $debugging = $config->get('system', 'debugging');
120 $stream = $config->get('system', 'dlogfile');
121 $developerIp = $config->get('system', 'dlogip');
123 if (!isset($developerIp) || !$debugging) {
124 $logger = new VoidLogger();
125 Logger::setDevLogger($logger);
129 $loggerTimeZone = new \DateTimeZone('UTC');
130 Monolog\Logger::setTimezone($loggerTimeZone);
132 $introspection = new Introspection(self::$ignoreClassList);
134 switch ($config->get('system', 'logger_config', 'stream')) {
137 $loggerTimeZone = new \DateTimeZone('UTC');
138 Monolog\Logger::setTimezone($loggerTimeZone);
140 $logger = new Monolog\Logger($channel);
141 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
142 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
143 $logger->pushProcessor(new Monolog\Processor\UidProcessor());
144 $logger->pushProcessor(new IntrospectionProcessor($introspection, LogLevel::DEBUG));
146 $logger->pushHandler(new DevelopHandler($developerIp));
148 static::addStreamHandler($logger, $stream, LogLevel::DEBUG);
152 $logger = new SyslogLogger($channel, $introspection, LogLevel::DEBUG);
157 $logger = new StreamLogger($channel, $stream, $introspection, LogLevel::DEBUG);
161 $profiling = $config->get('system', 'profiling', false);
163 // In case profiling is enabled, wrap the ProfilerLogger around the current logger
164 if (isset($profiling) && $profiling !== false) {
165 $logger = new ProfilerLogger($logger, $profiler);
168 Logger::setDevLogger($logger);
174 * Mapping a legacy level to the PSR-3 compliant levels
175 * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
177 * @param string $level the level to be mapped
179 * @return string the PSR-3 compliant level
181 private static function mapLegacyConfigDebugLevel($level)
186 return LogLevel::ERROR;
189 return LogLevel::WARNING;
192 return LogLevel::NOTICE;
195 return LogLevel::INFO;
198 return LogLevel::DEBUG;
201 return LogLevel::DEBUG;
202 // default if nothing set
209 * Adding a handler to a given logger instance
211 * @param LoggerInterface $logger The logger instance
212 * @param mixed $stream The stream which handles the logger output
213 * @param string $level The level, for which this handler at least should handle logging
217 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
218 * @throws \Exception in case of general failures
220 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
222 if ($logger instanceof Monolog\Logger) {
223 $loglevel = Monolog\Logger::toMonologLevel($level);
225 // fallback to notice if an invalid loglevel is set
226 if (!is_int($loglevel)) {
227 $loglevel = LogLevel::NOTICE;
230 $fileHandler = new Monolog\Handler\StreamHandler($stream, $loglevel);
232 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
233 $fileHandler->setFormatter($formatter);
235 $logger->pushHandler($fileHandler);
237 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
241 public static function addVoidHandler($logger)
243 if ($logger instanceof Monolog\Logger) {
244 $logger->pushHandler(new Monolog\Handler\NullHandler());