ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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)
 
- 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$recordThe 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$recordPartial log record containing only a level key
Returns
Boolean
} More...
 
 handleBatch (array $records)
 {Handles a set of records at once.
Parameters
array$recordsThe 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 Member Functions

 write (array $record)
 
 getDefaultFormatter ()
 
- 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...
 
- Protected Member Functions inherited from Monolog\Handler\AbstractHandler
 getDefaultFormatter ()
 Gets the default formatter. More...
 

Private Attributes

 $redisClient
 
 $redisKey
 

Additional Inherited Members

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

Detailed Description

Logs to a Redis key using rpush.

usage example:

$log = new Logger('application'); $redis = new RedisHandler(new Predis("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 
)
Parameters
\Predis\Client | \Redis$redisThe redis instance
string$keyThe key name to push records to
integer$levelThe minimum logging level at which this handler will be triggered
boolean$bubbleWhether the messages that are handled can bubble up the stack or not

Definition at line 39 of file RedisHandler.php.

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

40  {
41  if (!(($redis instanceof \Predis\Client) || ($redis instanceof \Redis))) {
42  throw new \InvalidArgumentException('Predis\Client or Redis instance required');
43  }
44 
45  $this->redisClient = $redis;
46  $this->redisKey = $key;
47 
48  parent::__construct($level, $bubble);
49  }

Member Function Documentation

◆ getDefaultFormatter()

Monolog\Handler\RedisHandler::getDefaultFormatter ( )
protected

Definition at line 59 of file RedisHandler.php.

60  {
61  return new LineFormatter();
62  }

◆ write()

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

Definition at line 51 of file RedisHandler.php.

52  {
53  $this->redisClient->rpush($this->redisKey, $record["formatted"]);
54  }

Field Documentation

◆ $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.


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