3 namespace Friendica\Util;
5 use Friendica\Network\HTTPException\InternalServerErrorException;
6 use Friendica\Util\Logger\FriendicaDevelopHandler;
8 use Psr\Log\LoggerInterface;
14 * Currently only Monolog is supported
19 * Creates a new PSR-3 compliant logger instances
21 * @param string $channel The channel of the logger instance
23 * @return LoggerInterface The PSR-3 compliant logger instance
25 public static function create($channel)
27 $logger = new Monolog\Logger($channel);
28 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
29 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
31 // Add more information in case of a warning and more
32 $logger->pushProcessor(new Monolog\Processor\IntrospectionProcessor(LogLevel::WARNING, [], 1));
38 * Creates a new PSR-3 compliant develop logger
40 * If you want to debug only interactions from your IP or the IP of a remote server for federation debug,
41 * you'll use this logger instance for the duration of your work.
43 * It should never get filled during normal usage of Friendica
45 * @param string $channel The channel of the logger instance
46 * @param string $developerIp The IP of the developer who wants to use the logger
48 * @return LoggerInterface The PSR-3 compliant logger instance
50 public static function createDev($channel, $developerIp)
52 $logger = new Monolog\Logger($channel);
53 $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor());
54 $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
56 $logger->pushProcessor(new Monolog\Processor\IntrospectionProcessor(Loglevel::DEBUG, [], 1));
58 $logger->pushHandler(new FriendicaDevelopHandler($developerIp));
64 * Adding a handler to a given logger instance
66 * @param LoggerInterface $logger The logger instance
67 * @param mixed $stream The stream which handles the logger output
68 * @param string $level The level, for which this handler at least should handle logging
72 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
73 * @throws \Exception in case of general failures
75 public static function addStreamHandler($logger, $stream, $level = LogLevel::NOTICE)
77 if ($logger instanceof Monolog\Logger) {
78 $fileHandler = new Monolog\Handler\StreamHandler($stream, Monolog\Logger::toMonologLevel($level));
80 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
81 $fileHandler->setFormatter($formatter);
83 $logger->pushHandler($fileHandler);
85 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');
90 * This method enables the test mode of a given logger
92 * @param LoggerInterface $logger The logger
94 * @return Monolog\Handler\TestHandler the Handling for tests
96 * @throws InternalServerErrorException if the logger is incompatible to the logger factory
98 public static function enableTest($logger)
100 if ($logger instanceof Monolog\Logger) {
101 // disable every handler so far
102 $logger->pushHandler(new Monolog\Handler\NullHandler());
104 // enable the test handler
105 $fileHandler = new Monolog\Handler\TestHandler();
106 $formatter = new Monolog\Formatter\LineFormatter("%datetime% %channel% [%level_name%]: %message% %context% %extra%\n");
107 $fileHandler->setFormatter($formatter);
109 $logger->pushHandler($fileHandler);
113 throw new InternalServerErrorException('Logger instance incompatible for MonologFactory');