friendica/src/Core/Logger.php

250 lines
5.0 KiB
PHP
Raw Normal View History

<?php
/**
* @file src/Core/Logger.php
*/
namespace Friendica\Core;
2018-12-30 15:42:56 -05:00
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/**
* @brief Logger functions
*/
2019-02-28 03:41:31 -05:00
class Logger
{
2018-12-30 15:42:56 -05:00
/**
* @see Logger::error()
*/
const WARNING = LogLevel::ERROR;
/**
* @see Logger::warning()
*/
const INFO = LogLevel::WARNING;
/**
* @see Logger::notice()
*/
const TRACE = LogLevel::NOTICE;
/**
* @see Logger::info()
*/
const DEBUG = LogLevel::INFO;
/**
* @see Logger::debug()
*/
const DATA = LogLevel::DEBUG;
/**
* @see Logger::debug()
*/
const ALL = LogLevel::DEBUG;
/**
* @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
*
*/
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.
*
* @param LoggerInterface $logger The Logger instance of this Application
*/
public static function init(LoggerInterface $logger)
2018-12-30 15:42:56 -05:00
{
self::$logger = $logger;
}
/**
* Sets the default dev-logging handler for Friendica.
2018-12-30 15:42:56 -05:00
*
* @param LoggerInterface $logger The Logger instance of this Application
2018-12-30 15:42:56 -05:00
*/
public static function setDevLogger(LoggerInterface $logger)
2018-12-30 15:42:56 -05:00
{
self::$devLogger = $logger;
2018-12-30 15:42:56 -05:00
}
/**
* System is unusable.
2019-01-06 16:06:53 -05:00
*
2018-12-30 15:42:56 -05:00
* @see LoggerInterface::emergency()
*
* @param string $message
* @param array $context
*
* @return void
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function emergency($message, $context = [])
{
self::$logger->emergency($message, $context);
}
/**
* 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
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function alert($message, $context = [])
{
self::$logger->alert($message, $context);
}
/**
* Critical conditions.
* @see LoggerInterface::critical()
*
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param array $context
*
* @return void
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function critical($message, $context = [])
{
self::$logger->critical($message, $context);
}
/**
* 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
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function error($message, $context = [])
{
self::$logger->error($message, $context);
}
/**
* 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
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function warning($message, $context = [])
{
self::$logger->warning($message, $context);
}
/**
* Normal but significant events.
* @see LoggerInterface::notice()
*
* @param string $message
* @param array $context
*
* @return void
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function notice($message, $context = [])
{
self::$logger->notice($message, $context);
}
/**
* Interesting events.
* @see LoggerInterface::info()
*
* Example: User logs in, SQL logs.
*
* @param string $message
* @param array $context
*
* @return void
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function info($message, $context = [])
{
self::$logger->info($message, $context);
}
/**
* Detailed debug information.
* @see LoggerInterface::debug()
*
* @param string $message
* @param array $context
*
* @return void
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
*/
public static function debug($message, $context = [])
{
self::$logger->debug($message, $context);
}
2019-02-16 20:09:39 -05:00
/**
* @brief Logs the given message at the given log level
*
* @param string $msg
* @param string $level
2018-12-30 15:42:56 -05:00
*
2019-01-06 16:06:53 -05:00
* @throws \Exception
2018-12-30 15:42:56 -05:00
* @deprecated since 2019.03 Use Logger::debug() Logger::info() , ... instead
2019-02-16 20:09:39 -05:00
*/
public static function log($msg, $level = LogLevel::INFO)
{
2019-01-07 15:08:09 -05:00
self::$logger->log($level, $msg);
2019-02-16 20:09:39 -05:00
}
2019-01-06 16:06:53 -05:00
/**
* @brief An alternative logger for development.
* Works largely as log() but allows developers
* to isolate particular elements they are targetting
* personally without background noise
*
* @param string $msg
2018-12-30 15:42:56 -05:00
* @param string $level
2019-01-06 16:06:53 -05:00
* @throws \Exception
*/
2019-02-16 20:09:39 -05:00
public static function devLog($msg, $level = LogLevel::DEBUG)
{
2019-02-28 03:41:31 -05:00
if (!isset(self::$devLogger)) {
2018-12-30 15:42:56 -05:00
return;
}
2019-02-16 19:18:21 -05:00
self::$devLogger->log($level, $msg);
2019-02-16 20:09:39 -05:00
}
}