diff --git a/doc/02-handlers-formatters-processors.md b/doc/02-handlers-formatters-processors.md index aeb77efd..c5f3abac 100644 --- a/doc/02-handlers-formatters-processors.md +++ b/doc/02-handlers-formatters-processors.md @@ -125,10 +125,10 @@ has accessors to read out the information. - [_HandlerWrapper_](../src/Monolog/Handler/HandlerWrapper.php): A simple handler wrapper you can inherit from to create your own wrappers easily. -- [_ThresholdHandler_](../src/Monolog/Handler/ThresholdHandler.php): This handler will buffer all the log messages it - receives, up until a configured threshold is reached, after it will pass all log messages to the wrapped handler. - Useful for applying in bath processing when you're only interested in significant failures instead of minor, single - erroneous events. +- [_OverflowHandler_](../src/Monolog/Handler/OverflowHandler.php): This handler will buffer all the log messages it + receives, up until a configured threshold of number of messages of a certain lever is reached, after it will pass all + log messages to the wrapped handler. Useful for applying in bath processing when you're only interested in significant + failures instead of minor, single erroneous events. ## Formatters diff --git a/src/Monolog/Handler/ThresholdHandler.php b/src/Monolog/Handler/OverflowHandler.php similarity index 91% rename from src/Monolog/Handler/ThresholdHandler.php rename to src/Monolog/Handler/OverflowHandler.php index 2b0949da..30e81c43 100644 --- a/src/Monolog/Handler/ThresholdHandler.php +++ b/src/Monolog/Handler/OverflowHandler.php @@ -15,7 +15,7 @@ use Monolog\Logger; /** - * Handler to only pass log messages when a certain threshold of messages is reached. + * 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? @@ -27,14 +27,14 @@ use Monolog\Logger; * $handler = new SomeHandler(...) * * // Pass all warnings to the handler when more than 10 & all error messages when more then 5 - * $threshold = new ThresholdHandler($handler, [Logger::WARNING => 10, Logger::ERROR => 5]); + * $overflow = new OverflowHandler($handler, [Logger::WARNING => 10, Logger::ERROR => 5]); * - * $log->pushHandler($threshold); + * $log->pushHandler($overflow); *``` * * @author Kris Buist */ -class ThresholdHandler extends AbstractHandler +class OverflowHandler extends AbstractHandler { /** @var HandlerInterface */ private $handler; @@ -105,7 +105,7 @@ class ThresholdHandler extends AbstractHandler } if ($this->thresholdMap[$level] > 0) { - // The threshold is not yet reached, so we're buffering the record and lowering the threshold by 1 + // 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; diff --git a/tests/Monolog/Handler/ThresholdHandlerTest.php b/tests/Monolog/Handler/OverflowHandlerTest.php similarity index 88% rename from tests/Monolog/Handler/ThresholdHandlerTest.php rename to tests/Monolog/Handler/OverflowHandlerTest.php index 4ad555d1..c62f441a 100644 --- a/tests/Monolog/Handler/ThresholdHandlerTest.php +++ b/tests/Monolog/Handler/OverflowHandlerTest.php @@ -16,14 +16,14 @@ use Monolog\Test\TestCase; /** * @author Kris Buist - * @covers \Monolog\Handler\ThresholdHandler + * @covers \Monolog\Handler\OverflowHandler */ -class ThresholdHandlerTest extends TestCase +class OverflowHandlerTest extends TestCase { public function testNotPassingRecordsBeneathLogLevel() { $testHandler = new TestHandler(); - $handler = new ThresholdHandler($testHandler, [], Logger::INFO); + $handler = new OverflowHandler($testHandler, [], Logger::INFO); $handler->handle($this->getRecord(Logger::DEBUG)); $this->assertFalse($testHandler->hasDebugRecords()); } @@ -31,7 +31,7 @@ class ThresholdHandlerTest extends TestCase public function testPassThroughWithoutThreshold() { $testHandler = new TestHandler(); - $handler = new ThresholdHandler($testHandler, [], Logger::INFO); + $handler = new OverflowHandler($testHandler, [], Logger::INFO); $handler->handle($this->getRecord(Logger::INFO, 'Info 1')); $handler->handle($this->getRecord(Logger::INFO, 'Info 2')); @@ -48,7 +48,7 @@ class ThresholdHandlerTest extends TestCase public function testHoldingMessagesBeneathThreshold() { $testHandler = new TestHandler(); - $handler = new ThresholdHandler($testHandler, [Logger::INFO => 3]); + $handler = new OverflowHandler($testHandler, [Logger::INFO => 3]); $handler->handle($this->getRecord(Logger::DEBUG, 'debug 1')); $handler->handle($this->getRecord(Logger::DEBUG, 'debug 2')); @@ -74,7 +74,7 @@ class ThresholdHandlerTest extends TestCase public function testCombinedThresholds() { $testHandler = new TestHandler(); - $handler = new ThresholdHandler($testHandler, [Logger::INFO => 5, Logger::WARNING => 10]); + $handler = new OverflowHandler($testHandler, [Logger::INFO => 5, Logger::WARNING => 10]); $handler->handle($this->getRecord(Logger::DEBUG));