Monolog\Handler\DeduplicationHandler Class Reference

Simple handler wrapper that deduplicates log records across multiple requests. More...

Inheritance diagram for Monolog\Handler\DeduplicationHandler:

Collaboration diagram for Monolog\Handler\DeduplicationHandler:

Public Member Functions
	__construct (HandlerInterface $handler, $deduplicationStore=null, $deduplicationLevel=Logger::ERROR, $time=60, $bubble=true)
	flush ()
Public Member Functions inherited from Monolog\Handler\BufferHandler
	__construct (HandlerInterface $handler, $bufferLimit=0, $level=Logger::DEBUG, $bubble=true, $flushOnOverflow=false)
	handle (array $record)
	{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. Parameters array $record The record to handle Returns Boolean 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. } More...
	flush ()
	__destruct ()
	close ()
	{} More...
	clear ()
	Clears the buffer without flushing any messages down to the wrapped handler. More...
Public Member Functions inherited from Monolog\Handler\AbstractHandler
	__construct ($level=Logger::DEBUG, $bubble=true)
	isHandling (array $record)
	{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record. Parameters array $record Partial log record containing only a level key Returns Boolean } More...
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	close ()
	Closes the handler. More...
	pushProcessor ($callback)
	{Adds a processor in the stack. Parameters callable $callback Returns self } More...
	popProcessor ()
	{Removes the processor on top of the stack and returns it. Returns callable } More...
	setFormatter (FormatterInterface $formatter)
	{Sets the formatter. Parameters FormatterInterface $formatter Returns self } More...
	getFormatter ()
	{Gets the formatter. Returns FormatterInterface } More...
	setLevel ($level)
	Sets minimum logging level at which this handler will be triggered. More...
	getLevel ()
	Gets minimum logging level at which this handler will be triggered. More...
	setBubble ($bubble)
	Sets the bubbling behavior. More...
	getBubble ()
	Gets the bubbling behavior. More...
	__destruct ()

Protected Attributes
	$deduplicationStore
	$deduplicationLevel
	$time
Protected Attributes inherited from Monolog\Handler\BufferHandler
	$handler
	$bufferSize = 0
	$bufferLimit
	$flushOnOverflow
	$buffer = array()
	$initialized = false
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Private Member Functions
	isDuplicate (array $record)
	collectLogs ()
	appendRecord (array $record)

Private Attributes
	$gc = false

Additional Inherited Members
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Detailed Description

Simple handler wrapper that deduplicates log records across multiple requests.

It also includes the BufferHandler functionality and will buffer all messages until the end of the request or flush() is called.

This works by storing all log records' messages above $deduplicationLevel to the file specified by $deduplicationStore. When further logs come in at the end of the request (or when flush() is called), all those above $deduplicationLevel are checked against the existing stored logs. If they match and the timestamps in the stored log is not older than $time seconds, the new log record is discarded. If no log record is new, the whole data set is discarded.

This is mainly useful in combination with Mail handlers or things like Slack or HipChat handlers that send messages to people, to avoid spamming with the same message over and over in case of a major component failure like a database server being down which makes all requests fail in the same way.

Author

Jordi Boggiano j.bog.nosp@m.gian.nosp@m.o@sel.nosp@m.d.be

Definition at line 36 of file DeduplicationHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\DeduplicationHandler::__construct	(	HandlerInterface	$handler,
			$deduplicationStore = null,
			$deduplicationLevel = Logger::ERROR,
			$time = 60,
			$bubble = true
	)

Parameters

HandlerInterface	$handler	Handler.
string	$deduplicationStore	The file/path where the deduplication log should be kept
int	$deduplicationLevel	The minimum logging level for log records to be looked at for deduplication purposes
int	$time	The period (in seconds) during which duplicate entries should be suppressed after a given log is sent through
Boolean	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 65 of file DeduplicationHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\DeduplicationHandler\$deduplicationLevel, Monolog\Handler\DeduplicationHandler\$deduplicationStore, Monolog\Handler\DeduplicationHandler\$time, Monolog\Logger\DEBUG, time, and Monolog\Logger\toMonologLevel().

    {
        parent::__construct($handler, 0, Logger::DEBUG, $bubble, false);

        $this->deduplicationStore = $deduplicationStore === null ? sys_get_temp_dir() . '/monolog-dedup-' . substr(md5(__FILE__), 0, 20) .'.log' : $deduplicationStore;
        $this->deduplicationLevel = Logger::toMonologLevel($deduplicationLevel);
        $this->time = $time;
    }

Here is the call graph for this function:

Member Function Documentation

appendRecord()

Monolog\Handler\DeduplicationHandler::appendRecord ( array  $record )

private

Definition at line 165 of file DeduplicationHandler.php.

Referenced by Monolog\Handler\DeduplicationHandler\flush().

    {
        file_put_contents($this->deduplicationStore, $record['datetime']->getTimestamp() . ':' . $record['level_name'] . ':' . preg_replace('{[\r\n].*}', '', $record['message']) . "\n", FILE_APPEND);
    }

Here is the caller graph for this function:

collectLogs()

Monolog\Handler\DeduplicationHandler::collectLogs ( )

private

Definition at line 134 of file DeduplicationHandler.php.

References $log, Monolog\Handler\DeduplicationHandler\$time, array, and time.

Referenced by Monolog\Handler\DeduplicationHandler\flush().

    {
        if (!file_exists($this->deduplicationStore)) {
            return false;
        }

        $handle = fopen($this->deduplicationStore, 'rw+');
        flock($handle, LOCK_EX);
        $validLogs = array();

        $timestampValidity = time() - $this->time;

        while (!feof($handle)) {
            $log = fgets($handle);
            if (substr($log, 0, 10) >= $timestampValidity) {
                $validLogs[] = $log;
            }
        }

        ftruncate($handle, 0);
        rewind($handle);
        foreach ($validLogs as $log) {
            fwrite($handle, $log);
        }

        flock($handle, LOCK_UN);
        fclose($handle);

        $this->gc = false;
    }

Here is the caller graph for this function:

flush()

Monolog\Handler\DeduplicationHandler::flush

(

)

Definition at line 74 of file DeduplicationHandler.php.

References Monolog\Handler\DeduplicationHandler\appendRecord(), Monolog\Handler\BufferHandler\clear(), Monolog\Handler\DeduplicationHandler\collectLogs(), and Monolog\Handler\DeduplicationHandler\isDuplicate().

    {
        if ($this->bufferSize === 0) {
            return;
        }

        $passthru = null;

        foreach ($this->buffer as $record) {
            if ($record['level'] >= $this->deduplicationLevel) {

                $passthru = $passthru || !$this->isDuplicate($record);
                if ($passthru) {
                    $this->appendRecord($record);
                }
            }
        }

        // default of null is valid as well as if no record matches duplicationLevel we just pass through
        if ($passthru === true || $passthru === null) {
            $this->handler->handleBatch($this->buffer);
        }

        $this->clear();

        if ($this->gc) {
            $this->collectLogs();
        }
    }

Here is the call graph for this function:

isDuplicate()

Monolog\Handler\DeduplicationHandler::isDuplicate ( array  $record )

private

Definition at line 104 of file DeduplicationHandler.php.

References $i, Monolog\Handler\AbstractHandler\$level, $message, $store, Monolog\Handler\DeduplicationHandler\$time, $timestamp, file, and time.

Referenced by Monolog\Handler\DeduplicationHandler\flush().

    {
        if (!file_exists($this->deduplicationStore)) {
            return false;
        }

        $store = file($this->deduplicationStore, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
        if (!is_array($store)) {
            return false;
        }

        $yesterday = time() - 86400;
        $timestampValidity = $record['datetime']->getTimestamp() - $this->time;
        $expectedMessage = preg_replace('{[\r\n].*}', '', $record['message']);

        for ($i = count($store) - 1; $i >= 0; $i--) {
            list($timestamp, $level, $message) = explode(':', $store[$i], 3);

            if ($level === $record['level_name'] && $message === $expectedMessage && $timestamp > $timestampValidity) {
                return true;
            }

            if ($timestamp < $yesterday) {
                $this->gc = true;
            }
        }

        return false;
    }

Here is the caller graph for this function:

Field Documentation

$deduplicationLevel

Monolog\Handler\DeduplicationHandler::$deduplicationLevel

protected

Definition at line 46 of file DeduplicationHandler.php.

Referenced by Monolog\Handler\DeduplicationHandler\__construct().

$deduplicationStore

Monolog\Handler\DeduplicationHandler::$deduplicationStore

protected

Definition at line 41 of file DeduplicationHandler.php.

Referenced by Monolog\Handler\DeduplicationHandler\__construct().

$gc

Monolog\Handler\DeduplicationHandler::$gc = false

private

Definition at line 56 of file DeduplicationHandler.php.

$time

Monolog\Handler\DeduplicationHandler::$time

protected

Definition at line 51 of file DeduplicationHandler.php.

Referenced by Monolog\Handler\DeduplicationHandler\__construct(), Monolog\Handler\DeduplicationHandler\collectLogs(), and Monolog\Handler\DeduplicationHandler\isDuplicate().

---

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

• libs/composer/vendor/monolog/monolog/src/Monolog/Handler/DeduplicationHandler.php