Monolog\Handler\SamplingHandler Class Reference

Sampling handler. More...

Inheritance diagram for Monolog\Handler\SamplingHandler:

Collaboration diagram for Monolog\Handler\SamplingHandler:

Public Member Functions
	__construct ($handler, $factor)
	isHandling (array $record)
	Checks whether the given record will be handled by this handler. More...
	handle (array $record)
	Handles a record. 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
	$handler
	$factor
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

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

Detailed Description

Sampling handler.

A sampled event stream can be useful for logging high frequency events in a production environment where you only need an idea of what is happening and are not concerned with capturing every occurrence. Since the decision to handle or not handle a particular event is determined randomly, the resulting sampled log is not guaranteed to contain 1/N of the events that occurred in the application, but based on the Law of large numbers, it will tend to be close to this ratio with a large number of attempts.

Author

Bryan Davis bd808.nosp@m.@wik.nosp@m.imedi.nosp@m.a.or.nosp@m.g

Kunal Mehta legok.nosp@m.tm@g.nosp@m.mail..nosp@m.com

Definition at line 28 of file SamplingHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\SamplingHandler::__construct	(		$handler,
			$factor
	)

Parameters

callable | HandlerInterface	$handler	Handler or factory callable($record, $fingersCrossedHandler).
int	$factor	Sample factor

Definition at line 44 of file SamplingHandler.php.

References Monolog\Handler\SamplingHandler\$factor, and Monolog\Handler\SamplingHandler\$handler.

    {
        parent::__construct();
        $this->handler = $handler;
        $this->factor = $factor;

        if (!$this->handler instanceof HandlerInterface && !is_callable($this->handler)) {
            throw new \RuntimeException("The given handler (".json_encode($this->handler).") is not a callable nor a Monolog\Handler\HandlerInterface object");
        }
    }

Member Function Documentation

handle()

Monolog\Handler\SamplingHandler::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.

Implements Monolog\Handler\HandlerInterface.

Definition at line 60 of file SamplingHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, and Monolog\Handler\SamplingHandler\isHandling().

    {
        if ($this->isHandling($record) && mt_rand(1, $this->factor) === 1) {
            // The same logic as in FingersCrossedHandler
            if (!$this->handler instanceof HandlerInterface) {
                $this->handler = call_user_func($this->handler, $record, $this);
                if (!$this->handler instanceof HandlerInterface) {
                    throw new \RuntimeException("The factory callable should return a HandlerInterface");
                }
            }

            if ($this->processors) {
                foreach ($this->processors as $processor) {
                    $record = call_user_func($processor, $record);
                }
            }

            $this->handler->handle($record);
        }

        return false === $this->bubble;
    }

Here is the call graph for this function:

isHandling()

Monolog\Handler\SamplingHandler::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

Implements Monolog\Handler\HandlerInterface.

Definition at line 55 of file SamplingHandler.php.

Referenced by Monolog\Handler\SamplingHandler\handle().

    {
        return $this->handler->isHandling($record);
    }

Here is the caller graph for this function:

Field Documentation

$factor

int Monolog\Handler\SamplingHandler::$factor

protected

Definition at line 38 of file SamplingHandler.php.

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

$handler

callable HandlerInterface Monolog\Handler\SamplingHandler::$handler

protected

Definition at line 33 of file SamplingHandler.php.

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

---

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

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