Monolog\Handler\RollbarHandler Class Reference

Sends errors to Rollbar. More...

Inheritance diagram for Monolog\Handler\RollbarHandler:

Collaboration diagram for Monolog\Handler\RollbarHandler:

Public Member Functions
	__construct (RollbarNotifier $rollbarNotifier, $level=Logger::ERROR, $bubble=true)
	flush ()
	close ()
	{Closes the handler.This will be called automatically when the object is destroyed} More...
	reset ()
	{} More...
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 bool 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 bool } 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 ()
	reset ()
	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...
	reset ()

Protected Member Functions
	write (array $record)
	{Writes the record down to the log of the implementing handler. Parameters array $record Returns void } 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...
Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

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

Private Attributes
	$hasRecords = false

Detailed Description

Sends errors to Rollbar.

If the context data contains a payload key, that is used as an array of payload options to RollbarNotifier's report_message/report_exception methods.

Rollbar's context info will contain the context + extra keys from the log record merged, and then on top of that a few keys:

• level (rollbar level name)
• monolog_level (monolog level name, raw level, as rollbar only has 5 but monolog 8)
• channel
• datetime (unix timestamp)

Author

Paul Statezny pauls.nosp@m.tate.nosp@m.zny@g.nosp@m.mail.nosp@m..com

Definition at line 34 of file RollbarHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\RollbarHandler::__construct	(	RollbarNotifier	$rollbarNotifier,
			$level = Logger::ERROR,
			$bubble = true
	)

Parameters

RollbarNotifier	$rollbarNotifier	RollbarNotifier object constructed with valid token
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

Definition at line 68 of file RollbarHandler.php.

    {
        $this->rollbarNotifier = $rollbarNotifier;
 
        parent::__construct($level, $bubble);
    }

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

Member Function Documentation

close()

Monolog\Handler\RollbarHandler::close

(

)

{Closes the handler.This will be called automatically when the object is destroyed}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 128 of file RollbarHandler.php.

    {
        $this->flush();
    }

References Monolog\Handler\RollbarHandler\flush().

Here is the call graph for this function:

flush()

Monolog\Handler\RollbarHandler::flush

(

)

Definition at line 117 of file RollbarHandler.php.

    {
        if ($this->hasRecords) {
            $this->rollbarNotifier->flush();
            $this->hasRecords = false;
        }
    }

Referenced by Monolog\Handler\RollbarHandler\close(), and Monolog\Handler\RollbarHandler\reset().

Here is the caller graph for this function:

reset()

Monolog\Handler\RollbarHandler::reset

(

)

{}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 136 of file RollbarHandler.php.

    {
        $this->flush();
 
        parent::reset();
    }

References Monolog\Handler\RollbarHandler\flush().

Here is the call graph for this function:

write()

Monolog\Handler\RollbarHandler::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 78 of file RollbarHandler.php.

    {
        if (!$this->initialized) {
            // __destructor() doesn't get called on Fatal errors
            register_shutdown_function(array($this, 'close'));
            $this->initialized = true;
        }
 
        $context = $record['context'];
        $payload = array();
        if (isset($context['payload'])) {
            $payload = $context['payload'];
            unset($context['payload']);
        }
        $context = array_merge($context, $record['extra'], array(
            'level' => $this->levelMap[$record['level']],
            'monolog_level' => $record['level_name'],
            'channel' => $record['channel'],
            'datetime' => $record['datetime']->format('U'),
        ));
 
        if (isset($context['exception']) && $context['exception'] instanceof Exception) {
            $payload['level'] = $context['level'];
            $exception = $context['exception'];
            unset($context['exception']);
 
            $this->rollbarNotifier->report_exception($exception, $context, $payload);
        } else {
            $this->rollbarNotifier->report_message(
                $record['message'],
                $context['level'],
                $context,
                $payload
            );
        }
 
        $this->hasRecords = true;
    }

References $context.

Field Documentation

$hasRecords

Monolog\Handler\RollbarHandler::$hasRecords = false

private

Definition at line 59 of file RollbarHandler.php.

$initialized

Monolog\Handler\RollbarHandler::$initialized = false

protected

Definition at line 61 of file RollbarHandler.php.

$levelMap

Monolog\Handler\RollbarHandler::$levelMap

protected

Initial value:

= array(
        Logger::DEBUG     => 'debug',
        Logger::INFO      => 'info',
        Logger::NOTICE    => 'info',
        Logger::WARNING   => 'warning',
        Logger::ERROR     => 'error',
        Logger::CRITICAL  => 'critical',
        Logger::ALERT     => 'critical',
        Logger::EMERGENCY => 'critical',
    )

Definition at line 43 of file RollbarHandler.php.

$rollbarNotifier

Monolog\Handler\RollbarHandler::$rollbarNotifier

protected

Definition at line 41 of file RollbarHandler.php.

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

---

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

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