Monolog\Handler\RedisHandler Class Reference

Logs to a Redis key using rpush. More...

Inheritance diagram for Monolog\Handler\RedisHandler:

Collaboration diagram for Monolog\Handler\RedisHandler:

Public Member Functions
	__construct ($redis, $key, $level=Logger::DEBUG, $bubble=true, $capSize=false)
Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	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...
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 ()
	isHandling (array $record)
	Checks whether the given record will be handled by this handler. More...
	handle (array $record)
	Handles a record. More...
	handleBatch (array $records)
	Handles a set of records at once. More...
	pushProcessor ($callback)
	Adds a processor in the stack. More...
	popProcessor ()
	Removes the processor on top of the stack and returns it. More...
	setFormatter (FormatterInterface $formatter)
	Sets the formatter. More...
	getFormatter ()
	Gets the formatter. More...

Protected Member Functions
	write (array $record)
	Writes the record down to the log of the implementing handler. Parameters array $record Returns void More...
	writeCapped (array $record)
	Write and cap the collection Writes the record to the redis list and caps its. More...
	getDefaultFormatter ()
	Gets the default formatter. Returns FormatterInterface More...
Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...
	processRecord (array $record)
	Processes a record. More...
	getDefaultFormatter ()
	Gets the default formatter. More...

Protected Attributes
	$capSize
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Private Attributes
	$redisClient
	$redisKey

Detailed Description

Logs to a Redis key using rpush.

usage example:

$log = new Logger('application'); $redis = new RedisHandler(new Predis\Client("tcp://localhost:6379"), "logs", "prod"); $log->pushHandler($redis);

Author

Thomas Tourlourat thoma.nosp@m.s@to.nosp@m.urlou.nosp@m.rat..nosp@m.com

Definition at line 28 of file RedisHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\RedisHandler::__construct	(		$redis,
			$key,
			$level = Logger::DEBUG,
			$bubble = true,
			$capSize = false
	)

Parameters

\Predis\Client | \Redis	$redis	The redis instance
string	$key	The key name to push records to
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not
int	$capSize	Number of entries to limit list size to

Definition at line 41 of file RedisHandler.php.

    {
        if (!(($redis instanceof \Predis\Client) || ($redis instanceof \Redis))) {
            throw new \InvalidArgumentException('Predis\Client or Redis instance required');
        }
 
        $this->redisClient = $redis;
        $this->redisKey = $key;
        $this->capSize = $capSize;
 
        parent::__construct($level, $bubble);
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\RedisHandler\$capSize, and Monolog\Handler\AbstractHandler\$level.

Member Function Documentation

getDefaultFormatter()

Monolog\Handler\RedisHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns

FormatterInterface

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 93 of file RedisHandler.php.

    {
        return new LineFormatter();
    }

write()

Monolog\Handler\RedisHandler::write ( array  $record )

protected

Writes the record down to the log of the implementing handler.

Parameters

array

$record

Returns

void

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 57 of file RedisHandler.php.

    {
        if ($this->capSize) {
            $this->writeCapped($record);
        } else {
            $this->redisClient->rpush($this->redisKey, $record["formatted"]);
        }
    }

References Monolog\Handler\RedisHandler\writeCapped().

Here is the call graph for this function:

writeCapped()

Monolog\Handler\RedisHandler::writeCapped ( array  $record )

protected

Write and cap the collection Writes the record to the redis list and caps its.

Parameters

array

$record

associative record array

Returns

void

Definition at line 73 of file RedisHandler.php.

    {
        if ($this->redisClient instanceof \Redis) {
            $this->redisClient->multi()
                ->rpush($this->redisKey, $record["formatted"])
                ->ltrim($this->redisKey, -$this->capSize, -1)
                ->exec();
        } else {
            $redisKey = $this->redisKey;
            $capSize = $this->capSize;
            $this->redisClient->transaction(function ($tx) use ($record, $redisKey, $capSize) {
                $tx->rpush($redisKey, $record["formatted"]);
                $tx->ltrim($redisKey, -$capSize, -1);
            });
        }
    }

References Monolog\Handler\RedisHandler\$capSize, and Monolog\Handler\RedisHandler\$redisKey.

Referenced by Monolog\Handler\RedisHandler\write().

Here is the caller graph for this function:

Field Documentation

$capSize

Monolog\Handler\RedisHandler::$capSize

protected

Definition at line 32 of file RedisHandler.php.

Referenced by Monolog\Handler\RedisHandler\__construct(), and Monolog\Handler\RedisHandler\writeCapped().

$redisClient

Monolog\Handler\RedisHandler::$redisClient

private

Definition at line 30 of file RedisHandler.php.

$redisKey

Monolog\Handler\RedisHandler::$redisKey

private

Definition at line 31 of file RedisHandler.php.

Referenced by Monolog\Handler\RedisHandler\writeCapped().

---

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

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