mirror of
https://github.com/friendica/friendica
synced 2025-04-27 13:10:10 +00:00
Adding Develop and normal Logging instances
This commit is contained in:
Philipp Holzer
Hypolite Petovan
parent
1702cb73e7
commit
8f9c0fe149
14 changed files with 454 additions and 214 deletions
|
|
@ -4,10 +4,11 @@
|
|||
*/
|
||||
namespace Friendica\Core;
|
||||
|
||||
use Friendica\App;
|
||||
use Friendica\BaseObject;
|
||||
use Monolog;
|
||||
use Friendica\Util\DateTimeFormat;
|
||||
use Friendica\Network\HTTPException\InternalServerErrorException;
|
||||
use Friendica\Util\LoggerFactory;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Psr\Log\LogLevel;
|
||||
|
||||
/**
|
||||
* @brief Logger functions
|
||||
|
|
@ -15,70 +16,298 @@ use Friendica\Util\DateTimeFormat;
|
|||
class Logger extends BaseObject
|
||||
{
|
||||
/**
|
||||
* Creates a basic Monolog instance for logging.
|
||||
*
|
||||
* @param string $application the current application name (index, daemon, ...)
|
||||
*
|
||||
* @return Monolog\Logger The Logger instance
|
||||
* @deprecated 2019.03 use Logger::error() instead
|
||||
* @see Logger::error()
|
||||
*/
|
||||
public static function create($application)
|
||||
{
|
||||
$logger = new Monolog\Logger($application);
|
||||
|
||||
$logger->pushProcessor(new Monolog\Processor\IntrospectionProcessor());
|
||||
$logger->pushProcessor(new Monolog\Processor\ProcessIdProcessor());
|
||||
$logger->pushProcessor(new Monolog\Processor\WebProcessor());
|
||||
$logger->pushProcessor(new App\FriendicaLoggerProcessor());
|
||||
|
||||
return $logger;
|
||||
}
|
||||
const WARNING = 0;
|
||||
/**
|
||||
* @deprecated 2019.03 use Logger::warning() instead
|
||||
* @see Logger::warning()
|
||||
*/
|
||||
const INFO = 1;
|
||||
/**
|
||||
* @deprecated 2019.03 use Logger::notice() instead
|
||||
* @see Logger::notice()
|
||||
*/
|
||||
const TRACE = 2;
|
||||
/**
|
||||
* @deprecated 2019.03 use Logger::info() instead
|
||||
* @see Logger::info()
|
||||
*/
|
||||
const DEBUG = 3;
|
||||
/**
|
||||
* @deprecated 2019.03 use Logger::debug() instead
|
||||
* @see Logger::debug()
|
||||
*/
|
||||
const DATA = 4;
|
||||
/**
|
||||
* @deprecated 2019.03 use Logger::debug() instead
|
||||
* @see Logger::debug()
|
||||
*/
|
||||
const ALL = 5;
|
||||
|
||||
/**
|
||||
* Sets the default Logging handler for this instance.
|
||||
* Can be combined with other handlers too if necessary.
|
||||
* @var array the legacy loglevels
|
||||
* @deprecated 2019.03 use PSR-3 loglevels
|
||||
* @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
|
||||
*
|
||||
* @param Monolog\Logger $logger The Logger instance of this Application
|
||||
* @param App $app The Friendica Application
|
||||
*/
|
||||
public static function loadDefaultHandler($logger, $app)
|
||||
{
|
||||
foreach ($logger->getProcessors() as $processor) {
|
||||
if ($processor instanceof App\FriendicaLoggerProcessor) {
|
||||
$processor->setProcessId($app->process_id);
|
||||
}
|
||||
}
|
||||
public static $levels = [
|
||||
self::WARNING => 'Warning',
|
||||
self::INFO => 'Info',
|
||||
self::TRACE => 'Trace',
|
||||
self::DEBUG => 'Debug',
|
||||
self::DATA => 'Data',
|
||||
self::ALL => 'All',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var LoggerInterface A PSR-3 compliant logger instance
|
||||
*/
|
||||
private static $logger;
|
||||
|
||||
/**
|
||||
* @var LoggerInterface A PSR-3 compliant logger instance for developing only
|
||||
*/
|
||||
private static $devLogger;
|
||||
|
||||
/**
|
||||
* Sets the default logging handler for Friendica.
|
||||
* @todo Can be combined with other handlers too if necessary, could be configurable.
|
||||
*
|
||||
* @param LoggerInterface $logger The Logger instance of this Application
|
||||
*
|
||||
* @throws InternalServerErrorException if the logger factory is incompatible to this logger
|
||||
*/
|
||||
public static function setLogger($logger)
|
||||
{
|
||||
$debugging = Config::get('system', 'debugging');
|
||||
$logfile = Config::get('system', 'logfile');
|
||||
$logfile = Config::get('system', 'logfile');
|
||||
$loglevel = intval(Config::get('system', 'loglevel'));
|
||||
|
||||
if (!$debugging || !$logfile) {
|
||||
return;
|
||||
}
|
||||
|
||||
$fileHandler = new Monolog\Handler\StreamHandler($logfile . ".1", $loglevel);
|
||||
$logger->pushHandler($fileHandler);
|
||||
LoggerFactory::addStreamHandler($logger, $logfile, $loglevel);
|
||||
|
||||
$logfile = Config::get('system', 'dlogfile');
|
||||
|
||||
if (!$logfile) {
|
||||
return;
|
||||
}
|
||||
|
||||
$developIp = Config::get('system', 'dlogip');
|
||||
|
||||
self::$devLogger = LoggerFactory::createDev('develop', $developIp);
|
||||
LoggerFactory::addStreamHandler(self::$devLogger, $logfile, LogLevel::DEBUG);
|
||||
}
|
||||
|
||||
// Log levels:
|
||||
//EMERGENCY
|
||||
//ALERT
|
||||
//CRITICAL
|
||||
const WARNING = 0; //ERROR
|
||||
const INFO = 1; //WARNING
|
||||
const TRACE = 2; //NOTICE(default)
|
||||
const DEBUG = 3; //INFO
|
||||
const DATA = 4; //INFO
|
||||
const ALL = 5; //DEBUG
|
||||
/**
|
||||
* System is unusable.
|
||||
* @see LoggerInterface::emergency()
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function emergency($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
public static $levels = [
|
||||
self::WARNING => 'Warning',
|
||||
self::INFO => 'Info',
|
||||
self::TRACE => 'Trace',
|
||||
self::DEBUG => 'Debug',
|
||||
self::DATA => 'Data',
|
||||
self::ALL => 'All',
|
||||
];
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->emergency($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Action must be taken immediately.
|
||||
* @see LoggerInterface::alert()
|
||||
*
|
||||
* Example: Entire website down, database unavailable, etc. This should
|
||||
* trigger the SMS alerts and wake you up.
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function alert($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->alert($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Critical conditions.
|
||||
* @see LoggerInterface::critical()
|
||||
*
|
||||
* Example: Application component unavailable, unexpected exception.
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function critical($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->critical($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Runtime errors that do not require immediate action but should typically
|
||||
* be logged and monitored.
|
||||
* @see LoggerInterface::error()
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function error($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->error($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Exceptional occurrences that are not errors.
|
||||
* @see LoggerInterface::warning()
|
||||
*
|
||||
* Example: Use of deprecated APIs, poor use of an API, undesirable things
|
||||
* that are not necessarily wrong.
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function warning($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->warning($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Normal but significant events.
|
||||
* @see LoggerInterface::notice()
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function notice($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->notice($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Interesting events.
|
||||
* @see LoggerInterface::info()
|
||||
*
|
||||
* Example: User logs in, SQL logs.
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
*/
|
||||
public static function info($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->info($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Detailed debug information.
|
||||
* @see LoggerInterface::debug()
|
||||
*
|
||||
* @param string $message
|
||||
* @param array $context
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public static function debug($message, $context = [])
|
||||
{
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
self::$logger->debug($message, $context);
|
||||
self::getApp()->saveTimestamp($stamp1, 'file');
|
||||
}
|
||||
|
||||
/**
|
||||
* Mapping a legacy level to the PSR-3 compliant levels
|
||||
* @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#5-psrlogloglevel
|
||||
*
|
||||
* @param int $level the level to be mapped
|
||||
*
|
||||
* @return string the PSR-3 compliant level
|
||||
*/
|
||||
private static function mapPSR3Level($level)
|
||||
{
|
||||
switch ($level) {
|
||||
case self::WARNING:
|
||||
return LogLevel::ERROR;
|
||||
case self::INFO:
|
||||
return LogLevel::WARNING;
|
||||
case self::TRACE:
|
||||
return LogLevel::NOTICE;
|
||||
case self::DEBUG:
|
||||
return LogLevel::INFO;
|
||||
case self::DATA:
|
||||
return LogLevel::DEBUG;
|
||||
case self::ALL:
|
||||
return LogLevel::DEBUG;
|
||||
default:
|
||||
return LogLevel::CRITICAL;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Logs the given message at the given log level
|
||||
|
|
@ -86,52 +315,19 @@ class Logger extends BaseObject
|
|||
* @param string $msg
|
||||
* @param int $level
|
||||
*
|
||||
* @deprecated since 2019.03 - use App->getLogger() instead
|
||||
* @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead
|
||||
*/
|
||||
public static function log($msg, $level = self::INFO)
|
||||
{
|
||||
$a = self::getApp();
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$debugging = Config::get('system', 'debugging');
|
||||
$logfile = Config::get('system', 'logfile');
|
||||
$loglevel = intval(Config::get('system', 'loglevel'));
|
||||
|
||||
if (
|
||||
!$debugging
|
||||
|| !$logfile
|
||||
|| $level > $loglevel
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$processId = session_id();
|
||||
|
||||
if ($processId == '')
|
||||
{
|
||||
$processId = $a->process_id;
|
||||
}
|
||||
|
||||
$callers = debug_backtrace();
|
||||
|
||||
if (count($callers) > 1) {
|
||||
$function = $callers[1]['function'];
|
||||
} else {
|
||||
$function = '';
|
||||
}
|
||||
|
||||
$logline = sprintf("%s@%s\t[%s]:%s:%s:%s\t%s\n",
|
||||
DateTimeFormat::utcNow(DateTimeFormat::ATOM),
|
||||
$processId,
|
||||
self::$levels[$level],
|
||||
basename($callers[0]['file']),
|
||||
$callers[0]['line'],
|
||||
$function,
|
||||
$msg
|
||||
);
|
||||
$loglevel = self::mapPSR3Level($level);
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
@file_put_contents($logfile, $logline, FILE_APPEND);
|
||||
$a->saveTimestamp($stamp1, "file");
|
||||
self::$logger->log($loglevel, $msg);
|
||||
self::getApp()->saveTimestamp($stamp1, "file");
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -141,49 +337,16 @@ class Logger extends BaseObject
|
|||
* personally without background noise
|
||||
*
|
||||
* @param string $msg
|
||||
*
|
||||
* * @deprecated since 2019.03 - never used
|
||||
* @param string $level
|
||||
*/
|
||||
public static function devLog($msg)
|
||||
public static function devLog($msg, $level = LogLevel::DEBUG)
|
||||
{
|
||||
$a = self::getApp();
|
||||
|
||||
$logfile = Config::get('system', 'dlogfile');
|
||||
|
||||
if (!$logfile) {
|
||||
return;
|
||||
}
|
||||
|
||||
$dlogip = Config::get('system', 'dlogip');
|
||||
|
||||
if (!is_null($dlogip) && $_SERVER['REMOTE_ADDR'] != $dlogip)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$processId = session_id();
|
||||
|
||||
if ($processId == '')
|
||||
{
|
||||
$processId = $a->process_id;
|
||||
}
|
||||
|
||||
if (!is_string($msg)) {
|
||||
$msg = var_export($msg, true);
|
||||
}
|
||||
|
||||
$callers = debug_backtrace();
|
||||
$logline = sprintf("%s@\t%s:\t%s:\t%s\t%s\t%s\n",
|
||||
DateTimeFormat::utcNow(),
|
||||
$processId,
|
||||
basename($callers[0]['file']),
|
||||
$callers[0]['line'],
|
||||
$callers[1]['function'],
|
||||
$msg
|
||||
);
|
||||
if (!isset(self::$logger)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$stamp1 = microtime(true);
|
||||
@file_put_contents($logfile, $logline, FILE_APPEND);
|
||||
$a->saveTimestamp($stamp1, "file");
|
||||
self::$devLogger->log($level, $msg);
|
||||
self::getApp()->saveTimestamp($stamp1, "file");
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue