friendica/src/Core/Logger.php

287 lines
6.3 KiB
PHP
Raw Normal View History

<?php
/**
2021-03-29 02:40:20 -04:00
* @copyright Copyright (C) 2010-2021, the Friendica project
2020-02-09 09:45:36 -05:00
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
2020-02-09 09:45:36 -05:00
namespace Friendica\Core;
use Friendica\DI;
use Friendica\Util\Logger\WorkerLogger;
2018-12-30 15:42:56 -05:00
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
/**
2020-01-19 01:05:23 -05:00
* Logger functions
*/
class Logger
{
2018-12-30 15:42:56 -05:00
/**
* @see Logger::error()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const WARNING = LogLevel::ERROR;
/**
* @see Logger::warning()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const INFO = LogLevel::WARNING;
/**
* @see Logger::notice()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const TRACE = LogLevel::NOTICE;
/**
* @see Logger::info()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const DEBUG = LogLevel::INFO;
/**
* @see Logger::debug()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const DATA = LogLevel::DEBUG;
/**
* @see Logger::debug()
* @deprecated since 2019.01
2018-12-30 15:42:56 -05:00
*/
const ALL = LogLevel::DEBUG;
/**
* @var LoggerInterface The default Logger type
*/
const TYPE_LOGGER = LoggerInterface::class;
/**
* @var WorkerLogger A specific worker logger type, which can be anabled
*/
const TYPE_WORKER = WorkerLogger::class;
/**
* @var LoggerInterface The current logger type
*/
private static $type = self::TYPE_LOGGER;
2018-12-30 15:42:56 -05:00
/**
* @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',
];
/**
* @return LoggerInterface
*/
private static function getWorker()
{
if (self::$type === self::TYPE_LOGGER) {
return DI::logger();
} else {
return DI::workerLogger();
}
}
2018-12-30 15:42:56 -05:00
/**
* Enable additional logging for worker usage
*
* @param string $functionName The worker function, which got called
2018-12-30 15:42:56 -05:00
*
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
2018-12-30 15:42:56 -05:00
*/
public static function enableWorker(string $functionName)
2018-12-30 15:42:56 -05:00
{
self::$type = self::TYPE_WORKER;
self::getWorker()->setFunctionName($functionName);
2018-12-30 15:42:56 -05:00
}
/**
* Disable additional logging for worker usage
2018-12-30 15:42:56 -05:00
*/
public static function disableWorker()
2018-12-30 15:42:56 -05:00
{
self::$type = self::TYPE_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::getWorker()->emergency($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->alert($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->critical($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->error($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->warning($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->notice($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->info($message, $context);
2018-12-30 15:42:56 -05:00
}
/**
* 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::getWorker()->debug($message, $context);
2018-12-30 15:42:56 -05:00
}
2020-01-19 01:05:23 -05:00
/**
* Logs the given message at the given log level
2019-02-16 20:09:39 -05:00
*
* @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)
{
self::getWorker()->log($level, $msg);
2019-02-16 20:09:39 -05:00
}
2019-01-06 16:06:53 -05:00
/**
2020-01-19 01:05:23 -05:00
* An alternative logger for development.
*
2019-01-06 16:06:53 -05:00
* 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)
{
DI::devLogger()->log($level, $msg);
2019-02-16 20:09:39 -05:00
}
}