diff --git a/config/defaults.config.php b/config/defaults.config.php index 694f75c220..d40d0c68d8 100644 --- a/config/defaults.config.php +++ b/config/defaults.config.php @@ -209,6 +209,10 @@ return [ // If activated, all hashtags will point to the local server. 'local_tags' => false, + // logger_adapter (String) + // Sets the logging adapter of Friendica globally (monolog, syslog) + 'logger_adapter' => 'monolog', + // max_batch_queue (Integer) // Maximum number of batched queue items for a single contact before subsequent messages are discarded. 'max_batch_queue' => 1000, diff --git a/src/Factory/LoggerFactory.php b/src/Factory/LoggerFactory.php index 77a09637c4..c6788aa62c 100644 --- a/src/Factory/LoggerFactory.php +++ b/src/Factory/LoggerFactory.php @@ -6,7 +6,8 @@ use Friendica\Core\Config\Configuration; use Friendica\Core\Logger; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Util\Logger\FriendicaDevelopHandler; -use Friendica\Util\Logger\FriendicaIntrospectionProcessor; +use Friendica\Util\Logger\Introspection; +use Friendica\Util\Logger\SyslogLogger; use Friendica\Util\Profiler; use Monolog; use Psr\Log\LoggerInterface; @@ -29,21 +30,32 @@ class LoggerFactory */ public static function create($channel, Configuration $config) { - $logger = new Monolog\Logger($channel); - $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); - $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); - $logger->pushProcessor(new Monolog\Processor\UidProcessor()); - $logger->pushProcessor(new FriendicaIntrospectionProcessor(LogLevel::DEBUG, [Logger::class, Profiler::class])); + switch ($config->get('system', 'logger_adapter', 'monolog')) { + case 'syslog': + $intorspector = new Introspection(LOG_DEBUG, [Logger::class, SyslogLogger::class, Profiler::class]); + $level = $config->get('system', 'loglevel'); - $debugging = $config->get('system', 'debugging'); - $stream = $config->get('system', 'logfile'); - $level = $config->get('system', 'loglevel'); + $logger = new SyslogLogger($channel, $intorspector, $level); + break; + case 'monolog': + default: + $logger = new Monolog\Logger($channel); + $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); + $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); + $logger->pushProcessor(new Monolog\Processor\UidProcessor()); + $logger->pushProcessor(new Introspection(LogLevel::DEBUG, [Logger::class, Profiler::class])); - if ($debugging) { - $loglevel = self::mapLegacyConfigDebugLevel((string)$level); - static::addStreamHandler($logger, $stream, $loglevel); - } else { - static::addVoidHandler($logger); + $debugging = $config->get('system', 'debugging'); + $stream = $config->get('system', 'logfile'); + $level = $config->get('system', 'loglevel'); + + if ($debugging) { + $loglevel = self::mapLegacyConfigDebugLevel((string)$level); + static::addStreamHandler($logger, $stream, $loglevel); + } else { + static::addVoidHandler($logger); + } + break; } Logger::init($logger); @@ -78,7 +90,7 @@ class LoggerFactory $logger->pushProcessor(new Monolog\Processor\PsrLogMessageProcessor()); $logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor()); $logger->pushProcessor(new Monolog\Processor\UidProcessor()); - $logger->pushProcessor(new FriendicaIntrospectionProcessor(LogLevel::DEBUG, ['Friendica\\Core\\Logger'])); + $logger->pushProcessor(new Introspection(LogLevel::DEBUG, ['Friendica\\Core\\Logger'])); $logger->pushHandler(new FriendicaDevelopHandler($developerIp)); diff --git a/src/Util/Logger/FriendicaIntrospectionProcessor.php b/src/Util/Logger/Introspection.php similarity index 82% rename from src/Util/Logger/FriendicaIntrospectionProcessor.php rename to src/Util/Logger/Introspection.php index aa3933a215..f99225f9a2 100644 --- a/src/Util/Logger/FriendicaIntrospectionProcessor.php +++ b/src/Util/Logger/Introspection.php @@ -11,7 +11,7 @@ use Monolog\Processor\ProcessorInterface; * Based on the class IntrospectionProcessor without the "class" information * @see IntrospectionProcessor */ -class FriendicaIntrospectionProcessor implements ProcessorInterface +class Introspection implements ProcessorInterface { private $level; @@ -42,7 +42,22 @@ class FriendicaIntrospectionProcessor implements ProcessorInterface if ($record['level'] < $this->level) { return $record; } + // we should have the call source now + $record['extra'] = array_merge( + $record['extra'], + $this->getRecord() + ); + return $record; + } + + /** + * Returns the introspection record of the current call + * + * @return array + */ + public function getRecord() + { $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); $i = 1; @@ -53,17 +68,11 @@ class FriendicaIntrospectionProcessor implements ProcessorInterface $i += $this->skipStackFramesCount; - // we should have the call source now - $record['extra'] = array_merge( - $record['extra'], - [ - 'file' => isset($trace[$i - 1]['file']) ? basename($trace[$i - 1]['file']) : null, - 'line' => isset($trace[$i - 1]['line']) ? $trace[$i - 1]['line'] : null, - 'function' => isset($trace[$i]['function']) ? $trace[$i]['function'] : null, - ] - ); - - return $record; + return [ + 'file' => isset($trace[$i - 1]['file']) ? basename($trace[$i - 1]['file']) : null, + 'line' => isset($trace[$i - 1]['line']) ? $trace[$i - 1]['line'] : null, + 'function' => isset($trace[$i]['function']) ? $trace[$i]['function'] : null, + ]; } /** diff --git a/src/Util/Logger/SyslogLogger.php b/src/Util/Logger/SyslogLogger.php new file mode 100644 index 0000000000..19395157d2 --- /dev/null +++ b/src/Util/Logger/SyslogLogger.php @@ -0,0 +1,297 @@ + LOG_DEBUG, + LogLevel::INFO => LOG_INFO, + LogLevel::NOTICE => LOG_NOTICE, + LogLevel::WARNING => LOG_WARNING, + LogLevel::ERROR => LOG_ERR, + LogLevel::CRITICAL => LOG_CRIT, + LogLevel::ALERT => LOG_ALERT, + LogLevel::EMERGENCY => LOG_EMERG, + ]; + + /** + * Translates log priorities to string outputs + * @var array + */ + private $logToString = [ + LOG_DEBUG => 'DEBUG', + LOG_INFO => 'INFO', + LOG_NOTICE => 'NOTICE', + LOG_WARNING => 'WARNING', + LOG_ERR => 'ERROR', + LOG_CRIT => 'CRITICAL', + LOG_ALERT => 'ALERT', + LOG_EMERG => 'EMERGENCY' + ]; + + /** + * The channel of the current process (added to each message) + * @var string + */ + private $channel; + + /** + * Indicates what logging options will be used when generating a log message + * @see http://php.net/manual/en/function.openlog.php#refsect1-function.openlog-parameters + * + * @var int + */ + private $logOpts; + + /** + * Used to specify what type of program is logging the message + * @see http://php.net/manual/en/function.openlog.php#refsect1-function.openlog-parameters + * + * @var int + */ + private $logFacility; + + /** + * The minimum loglevel at which this logger will be triggered + * @var int + */ + private $logLevel; + + /** + * The Introspector for the current call + * @var Introspection + */ + private $introspection; + + /** + * The UID of the current call + * @var string + */ + private $logUid; + + /** + * @param string $channel The output channel + * @param string $level The minimum loglevel at which this logger will be triggered + * @param int $logOpts Indicates what logging options will be used when generating a log message + * @param int $logFacility Used to specify what type of program is logging the message + */ + public function __construct($channel, Introspection $introspection, $level = LogLevel::NOTICE, $logOpts = LOG_PID, $logFacility = LOG_USER) + { + $this->logUid = Strings::getRandomHex(6); + $this->channel = $channel; + $this->logOpts = $logOpts; + $this->logFacility = $logFacility; + $this->logLevel = $this->mapLevelToPriority($level); + $this->introspection = $introspection; + } + + /** + * Maps the LogLevel (@see LogLevel ) to a SysLog priority (@see http://php.net/manual/en/function.syslog.php#refsect1-function.syslog-parameters ) + * + * @param string $level A LogLevel + * + * @return int The SysLog priority + * + * @throws \Psr\Log\InvalidArgumentException If the loglevel isn't valid + */ + public function mapLevelToPriority($level) + { + if (!array_key_exists($level, $this->logLevels)) { + throw new InvalidArgumentException('LogLevel \'' . $level . '\' isn\'t valid.'); + } + + return $this->logLevels[$level]; + } + + /** + * Writes a message to the syslog + * @see http://php.net/manual/en/function.syslog.php#refsect1-function.syslog-parameters + * + * @param int $priority The Priority + * @param string $message The message of the log + * + * @throws InternalServerErrorException if syslog cannot be used + */ + private function write($priority, $message) + { + if (!openlog(self::IDENT, $this->logOpts, $this->logFacility)) { + throw new InternalServerErrorException('Can\'t open syslog for ident "' . $this->channel . '" and facility "' . $this->logFacility . '""'); + } + + syslog($priority, $message); + } + + /** + * Closes the Syslog + */ + public function close() + { + closelog(); + } + + /** + * Formats a log record for the syslog output + * + * @param int $level The loglevel/priority + * @param string $message The message + * @param array $context The context of this call + * + * @return string the formatted syslog output + */ + private function formatLog($level, $message, $context = []) + { + $record = $this->introspection->getRecord(); + $record = array_merge($record, ['uid' => $this->logUid]); + $logMessage = ''; + + $logMessage .= $this->channel . ' '; + $logMessage .= '[' . $this->logToString[$level] . ']: '; + $logMessage .= $this->psrInterpolate($message, $context) . ' '; + $logMessage .= @json_encode($context) . ' - '; + $logMessage .= @json_encode($record); + + return $logMessage; + } + + /** + * Simple interpolation of PSR-3 compliant replacements ( variables between '{' and '}' ) + * @see https://www.php-fig.org/psr/psr-3/#12-message + * + * @param string $message + * @param array $context + * + * @return string the interpolated message + */ + private function psrInterpolate($message, array $context = array()) + { + $replace = []; + foreach ($context as $key => $value) { + // check that the value can be casted to string + if (!is_array($value) && (!is_object($value) || method_exists($value, '__toString'))) { + $replace['{' . $key . '}'] = $value; + } elseif (is_array($value)) { + $replace['{' . $key . '}'] = @json_encode($value); + } + } + + return strtr($message, $replace); + } + + /** + * Adds a new entry to the syslog + * + * @param int $level + * @param string $message + * @param array $context + * + * @throws InternalServerErrorException if the syslog isn't available + */ + private function addEntry($level, $message, $context = []) + { + if ($level >= $this->logLevel) { + return; + } + + $formattedLog = $this->formatLog($level, $message, $context); + $this->write($level, $formattedLog); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function emergency($message, array $context = array()) + { + $this->addEntry(LOG_EMERG, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function alert($message, array $context = array()) + { + $this->addEntry(LOG_ALERT, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function critical($message, array $context = array()) + { + $this->addEntry(LOG_CRIT, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function error($message, array $context = array()) + { + $this->addEntry(LOG_ERR, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function warning($message, array $context = array()) + { + $this->addEntry(LOG_WARNING, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function notice($message, array $context = array()) + { + $this->addEntry(LOG_NOTICE, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function info($message, array $context = array()) + { + $this->addEntry(LOG_INFO, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function debug($message, array $context = array()) + { + $this->addEntry(LOG_DEBUG, $message, $context); + } + + /** + * {@inheritdoc} + * @throws InternalServerErrorException if the syslog isn't available + */ + public function log($level, $message, array $context = array()) + { + $logLevel = $this->mapLevelToPriority($level); + $this->addEntry($logLevel, $message, $context); + } +}