Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7396206
OverflowHandler.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
4 KB
Referenced Files
None
Subscribers
None
OverflowHandler.php
View Options
<?php
declare
(
strict_types
=
1
);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace
Monolog\Handler
;
use
Monolog\Logger
;
use
Monolog\Formatter\FormatterInterface
;
/**
* 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);
*```
*
* @author Kris Buist <krisbuist@gmail.com>
*/
class
OverflowHandler
extends
AbstractHandler
implements
FormattableHandlerInterface
{
/** @var HandlerInterface */
private
$handler
;
/** @var int[] */
private
$thresholdMap
=
[
Logger
::
DEBUG
=>
0
,
Logger
::
INFO
=>
0
,
Logger
::
NOTICE
=>
0
,
Logger
::
WARNING
=>
0
,
Logger
::
ERROR
=>
0
,
Logger
::
CRITICAL
=>
0
,
Logger
::
ALERT
=>
0
,
Logger
::
EMERGENCY
=>
0
,
];
/**
* Buffer of all messages passed to the handler before the threshold was reached
*
* @var mixed[][]
*/
private
$buffer
=
[];
/**
* @param HandlerInterface $handler
* @param int[] $thresholdMap Dictionary of logger level => threshold
*/
public
function
__construct
(
HandlerInterface
$handler
,
array
$thresholdMap
=
[],
$level
=
Logger
::
DEBUG
,
bool
$bubble
=
true
)
{
$this
->
handler
=
$handler
;
foreach
(
$thresholdMap
as
$thresholdLevel
=>
$threshold
)
{
$this
->
thresholdMap
[
$thresholdLevel
]
=
$threshold
;
}
parent
::
__construct
(
$level
,
$bubble
);
}
/**
* Handles a record.
*
* 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.
*
* {@inheritDoc}
*/
public
function
handle
(
array
$record
):
bool
{
if
(
$record
[
'level'
]
<
$this
->
level
)
{
return
false
;
}
$level
=
$record
[
'level'
];
if
(!
isset
(
$this
->
thresholdMap
[
$level
]))
{
$this
->
thresholdMap
[
$level
]
=
0
;
}
if
(
$this
->
thresholdMap
[
$level
]
>
0
)
{
// The overflow threshold is not yet reached, so we're buffering the record and lowering the threshold by 1
$this
->
thresholdMap
[
$level
]--;
$this
->
buffer
[
$level
][]
=
$record
;
return
false
===
$this
->
bubble
;
}
if
(
$this
->
thresholdMap
[
$level
]
==
0
)
{
// This current message is breaking the threshold. Flush the buffer and continue handling the current record
foreach
(
$this
->
buffer
[
$level
]
??
[]
as
$buffered
)
{
$this
->
handler
->
handle
(
$buffered
);
}
$this
->
thresholdMap
[
$level
]--;
unset
(
$this
->
buffer
[
$level
]);
}
$this
->
handler
->
handle
(
$record
);
return
false
===
$this
->
bubble
;
}
/**
* {@inheritDoc}
*/
public
function
setFormatter
(
FormatterInterface
$formatter
):
HandlerInterface
{
if
(
$this
->
handler
instanceof
FormattableHandlerInterface
)
{
$this
->
handler
->
setFormatter
(
$formatter
);
return
$this
;
}
throw
new
\UnexpectedValueException
(
'The nested handler of type '
.
get_class
(
$this
->
handler
).
' does not support formatters.'
);
}
/**
* {@inheritDoc}
*/
public
function
getFormatter
():
FormatterInterface
{
if
(
$this
->
handler
instanceof
FormattableHandlerInterface
)
{
return
$this
->
handler
->
getFormatter
();
}
throw
new
\UnexpectedValueException
(
'The nested handler of type '
.
get_class
(
$this
->
handler
).
' does not support formatters.'
);
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 14:04 (6 h, 53 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
bb/5c/b50f36feb2e2c41769b77d35797e
Default Alt Text
OverflowHandler.php (4 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment