MediaWiki master
MediaWiki\Logger\LegacyLogger Class Reference

PSR-3 logger that mimics the historic implementation of MediaWiki's former wfErrorLog logging implementation. More...

Inherits AbstractLogger.

Collaboration diagram for MediaWiki\Logger\LegacyLogger:

Public Member Functions

 __construct ( $channel)
 
 log ( $level, $message, array $context=[])
 Logs with an arbitrary level.
 
 setMinimumForTest (?int $level)
 Change an existing Logger singleton to act like NullLogger.
 

Static Public Member Functions

static emit ( $text, $file)
 Log to a file without getting "file size exceeded" signals.
 
static format ( $channel, $message, $context)
 Format a message.
 
static interpolate ( $message, array $context)
 Interpolate placeholders in logging message.
 
static shouldEmit ( $channel, $message, $level, $context)
 Determine if the given message should be emitted or not.
 

Static Protected Member Functions

static destination ( $channel, $message, $context)
 Select the appropriate log output destination for the given log event.
 
static flatten ( $item)
 Convert a logging context element to a string suitable for interpolation.
 
static formatAsWfDebug ( $channel, $message, $context)
 Format a message as wfDebug() would have formatted it.
 
static formatAsWfDebugLog ( $channel, $message, $context)
 Format a message as `wfDebugLog() would have formatted it.
 
static formatAsWfLogDBError ( $channel, $message, $context)
 Format a message as wfLogDBError() would have formatted it.
 

Protected Attributes

string $channel
 

Static Protected Attributes

static array $levelMapping
 Convert \Psr\Log\LogLevel constants into int for sensible comparisons These are the same values that Monolog uses.
 

Detailed Description

PSR-3 logger that mimics the historic implementation of MediaWiki's former wfErrorLog logging implementation.

This logger is configured by the following global configuration variables:

  • $wgDebugLogFile
  • $wgDebugLogGroups
  • $wgDBerrorLog
  • $wgDBerrorLogTZ

See docs/Configuration.md for detailed explanations of these settings.

See also
\MediaWiki\Logger\LoggerFactory
Since
1.25
Note
© 2014 Wikimedia Foundation and contributors

Definition at line 52 of file LegacyLogger.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Logger\LegacyLogger::__construct (   $channel)

Member Function Documentation

◆ destination()

static MediaWiki\Logger\LegacyLogger::destination (   $channel,
  $message,
  $context 
)
staticprotected

Select the appropriate log output destination for the given log event.

If the event context contains 'destination'

Parameters
string$channel
string$message
array$context
Returns
string

Definition at line 471 of file LegacyLogger.php.

References MediaWiki\Logger\LegacyLogger\$channel, $wgDBerrorLog, $wgDebugLogFile, and $wgDebugLogGroups.

Referenced by MediaWiki\Logger\LegacyLogger\log().

◆ emit()

static MediaWiki\Logger\LegacyLogger::emit (   $text,
  $file 
)
static

Log to a file without getting "file size exceeded" signals.

Can also log to UDP with the syntax udp://host:port/prefix. This will send lines to the specified port, prefixed by the specified prefix and a space.

Parameters
string$text
string$fileFilename

Definition at line 510 of file LegacyLogger.php.

References UDPTransport\newFromString().

Referenced by MediaWiki\Api\ApiEntryPoint\execute(), and MediaWiki\Logger\LegacyLogger\log().

◆ flatten()

static MediaWiki\Logger\LegacyLogger::flatten (   $item)
staticprotected

Convert a logging context element to a string suitable for interpolation.

Parameters
mixed$item
Returns
string

Definition at line 407 of file LegacyLogger.php.

Referenced by MediaWiki\Logger\LegacyLogger\interpolate().

◆ format()

static MediaWiki\Logger\LegacyLogger::format (   $channel,
  $message,
  $context 
)
static

Format a message.

Messages to the 'wfDebug' and 'wfLogDBError' channels receive special formatting to mimic the historic output of the functions of the same name. All other channel values are formatted based on the historic output of the wfDebugLog() global function.

Parameters
string$channel
string$message
array$context
Returns
string

Definition at line 279 of file LegacyLogger.php.

References MediaWiki\Logger\LegacyLogger\$channel, $wgDebugLogGroups, $wgLogExceptionBacktrace, MediaWiki\Logger\LegacyLogger\formatAsWfDebug(), MediaWiki\Logger\LegacyLogger\formatAsWfDebugLog(), MediaWiki\Logger\LegacyLogger\formatAsWfLogDBError(), MWExceptionHandler\getRedactedTrace(), MediaWiki\Logger\LegacyLogger\interpolate(), and MWExceptionHandler\prettyPrintTrace().

Referenced by MediaWiki\Logger\ConsoleLogger\log(), and MediaWiki\Logger\LegacyLogger\log().

◆ formatAsWfDebug()

static MediaWiki\Logger\LegacyLogger::formatAsWfDebug (   $channel,
  $message,
  $context 
)
staticprotected

Format a message as wfDebug() would have formatted it.

Parameters
string$channel
string$message
array$context
Returns
string

Definition at line 327 of file LegacyLogger.php.

Referenced by MediaWiki\Logger\LegacyLogger\format().

◆ formatAsWfDebugLog()

static MediaWiki\Logger\LegacyLogger::formatAsWfDebugLog (   $channel,
  $message,
  $context 
)
staticprotected

Format a message as `wfDebugLog() would have formatted it.

Parameters
string$channel
string$message
array$context
Returns
string

Definition at line 374 of file LegacyLogger.php.

References wfHostname(), and wfTimestamp().

Referenced by MediaWiki\Logger\LegacyLogger\format().

◆ formatAsWfLogDBError()

static MediaWiki\Logger\LegacyLogger::formatAsWfLogDBError (   $channel,
  $message,
  $context 
)
staticprotected

Format a message as wfLogDBError() would have formatted it.

Parameters
string$channel
string$message
array$context
Returns
string

Definition at line 348 of file LegacyLogger.php.

References $wgDBerrorLogTZ, and wfHostname().

Referenced by MediaWiki\Logger\LegacyLogger\format().

◆ interpolate()

static MediaWiki\Logger\LegacyLogger::interpolate (   $message,
array  $context 
)
static

Interpolate placeholders in logging message.

Parameters
string$message
array$context
Returns
string Interpolated message

Definition at line 389 of file LegacyLogger.php.

References MediaWiki\Logger\LegacyLogger\flatten().

Referenced by MediaWiki\Logger\LegacyLogger\format().

◆ log()

MediaWiki\Logger\LegacyLogger::log (   $level,
  $message,
array  $context = [] 
)

Logs with an arbitrary level.

Parameters
string | int$level
string$message
array$context

Definition at line 159 of file LegacyLogger.php.

References MediaWiki\Logger\LegacyLogger\$channel, $wgDBerrorLog, MWDebug\debugMsg(), MediaWiki\Logger\LegacyLogger\destination(), MediaWiki\Logger\LegacyLogger\emit(), MediaWiki\Logger\LegacyLogger\format(), and MWDebug\query().

◆ setMinimumForTest()

MediaWiki\Logger\LegacyLogger::setMinimumForTest ( ?int  $level)

Change an existing Logger singleton to act like NullLogger.

Access: internal
For use by MediaWikiIntegrationTestCase::setNullLogger
Parameters
null | int$level
Returns
int

Definition at line 142 of file LegacyLogger.php.

◆ shouldEmit()

static MediaWiki\Logger\LegacyLogger::shouldEmit (   $channel,
  $message,
  $level,
  $context 
)
static

Determine if the given message should be emitted or not.

Parameters
string$channel
string$message
string | int$level\Psr\Log\LogEvent constant or Monolog level int
array$context
Returns
bool True if message should be sent to disk/network, false otherwise

Definition at line 215 of file LegacyLogger.php.

References MediaWiki\Logger\LegacyLogger\$channel, $wgDBerrorLog, $wgDebugLogFile, and $wgDebugLogGroups.

Member Data Documentation

◆ $channel

◆ $levelMapping

array MediaWiki\Logger\LegacyLogger::$levelMapping
staticprotected
Initial value:
= [
LogLevel::DEBUG => self::LEVEL_DEBUG,
LogLevel::INFO => self::LEVEL_INFO,
LogLevel::NOTICE => self::LEVEL_NOTICE,
LogLevel::WARNING => self::LEVEL_WARNING,
LogLevel::ERROR => self::LEVEL_ERROR,
LogLevel::CRITICAL => self::LEVEL_CRITICAL,
LogLevel::ALERT => self::LEVEL_ALERT,
LogLevel::EMERGENCY => self::LEVEL_EMERGENCY,
]

Convert \Psr\Log\LogLevel constants into int for sensible comparisons These are the same values that Monolog uses.

Definition at line 75 of file LegacyLogger.php.


The documentation for this class was generated from the following file: