OverflowHandler
extends AbstractHandler
in package
implements
FormattableHandlerInterface
Handler to only pass log messages when a certain threshold of number of messages is reached.
This can be useful in cases of processing a batch of data, but you're for example only interested in case it fails catastrophically instead of a warning for 1 or 2 events. Worse things can happen, right?
Usage example:
$log = new Logger('application');
$handler = new SomeHandler(...)
// Pass all warnings to the handler when more than 10 & all error messages when more then 5
$overflow = new OverflowHandler($handler, [Logger::WARNING => 10, Logger::ERROR => 5]);
$log->pushHandler($overflow);
Tags
Interfaces, Classes and Traits
- FormattableHandlerInterface
- Interface to describe loggers that have a formatter
Table of Contents
- $bubble : mixed
- $formatter : FormatterInterface
- $level : mixed
- $processors : mixed
- $buffer : array<string|int, array<string|int, mixed>>
- Buffer of all messages passed to the handler before the threshold was reached
- $handler : HandlerInterface
- $thresholdMap : array<string|int, int>
- __construct() : mixed
- __destruct() : mixed
- close() : mixed
- Closes the handler.
- getBubble() : bool
- Gets the bubbling behavior.
- getFormatter() : FormatterInterface
- Gets the formatter.
- getLevel() : int
- Gets minimum logging level at which this handler will be triggered.
- handle() : bool
- Handles a record.
- handleBatch() : mixed
- Handles a set of records at once.
- isHandling() : bool
- Checks whether the given record will be handled by this handler.
- popProcessor() : callable
- Removes the processor on top of the stack and returns it.
- pushProcessor() : self
- Adds a processor in the stack.
- reset() : mixed
- setBubble() : self
- Sets the bubbling behavior.
- setFormatter() : self
- Sets the formatter.
- setLevel() : self
- Sets minimum logging level at which this handler will be triggered.
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
Properties
$bubble
protected
mixed
$bubble
= true
$formatter
protected
FormatterInterface
$formatter
$level
protected
mixed
$level
= MonologLogger::DEBUG
$processors
protected
mixed
$processors
= array()
$buffer
Buffer of all messages passed to the handler before the threshold was reached
private
array<string|int, array<string|int, mixed>>
$buffer
= []
$handler
private
HandlerInterface
$handler
$thresholdMap
private
array<string|int, int>
$thresholdMap
= [MonologLogger::DEBUG => 0, MonologLogger::INFO => 0, MonologLogger::NOTICE => 0, MonologLogger::WARNING => 0, MonologLogger::ERROR => 0, MonologLogger::CRITICAL => 0, MonologLogger::ALERT => 0, MonologLogger::EMERGENCY => 0]
Methods
__construct()
public
__construct(HandlerInterface $handler[, array<string|int, int> $thresholdMap = [] ][, int|string $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
- $handler : HandlerInterface
- $thresholdMap : array<string|int, int> = []
-
Dictionary of logger level => threshold
- $level : int|string = Logger::DEBUG
-
The minimum logging level at which this handler will be triggered
- $bubble : bool = true
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —close()
Closes the handler.
public
close() : mixed
This will be called automatically when the object is destroyed
Return values
mixed —getBubble()
Gets the bubbling behavior.
public
getBubble() : bool
Return values
bool —true means that this handler allows bubbling. false means that bubbling is not permitted.
getFormatter()
Gets the formatter.
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Return values
int —handle()
Handles a record.
public
handle(array<string|int, mixed> $record) : bool
All records may be passed to this method, and the handler should discard those that it does not want to handle.
The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.
Parameters
- $record : array<string|int, mixed>
-
The record to handle
Return values
bool —true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.
handleBatch()
Handles a set of records at once.
public
handleBatch(array<string|int, mixed> $records) : mixed
Parameters
- $records : array<string|int, mixed>
-
The records to handle (an array of record arrays)
Return values
mixed —isHandling()
Checks whether the given record will be handled by this handler.
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
-
Partial log record containing only a level key
Return values
bool —popProcessor()
Removes the processor on top of the stack and returns it.
public
popProcessor() : callable
Return values
callable —pushProcessor()
Adds a processor in the stack.
public
pushProcessor(mixed $callback) : self
Parameters
- $callback : mixed
Return values
self —reset()
public
reset() : mixed
Return values
mixed —setBubble()
Sets the bubbling behavior.
public
setBubble(bool $bubble) : self
Parameters
- $bubble : bool
-
true means that this handler allows bubbling. false means that bubbling is not permitted.
Return values
self —setFormatter()
Sets the formatter.
public
setFormatter(FormatterInterface $formatter) : self
Parameters
- $formatter : FormatterInterface
Return values
self —setLevel()
Sets minimum logging level at which this handler will be triggered.
public
setLevel(int|string $level) : self
Parameters
- $level : int|string
-
Level or level name
Return values
self —getDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface