Monolog\Handler\RavenHandler Class Reference

Handler to send messages to a Sentry (https://github.com/getsentry/sentry) server using raven-php (https://github.com/getsentry/raven-php) More...

Inheritance diagram for Monolog\Handler\RavenHandler:

Collaboration diagram for Monolog\Handler\RavenHandler:

Public Member Functions
	__construct (Raven_Client $ravenClient, $level=Logger::DEBUG, $bubble=true)
	handleBatch (array $records)
	{Handles a set of records at once. Parameters array $records The records to handle (an array of record arrays) } More...
	setBatchFormatter (FormatterInterface $formatter)
	Sets the formatter for the logs generated by handleBatch(). More...
	getBatchFormatter ()
	Gets the formatter for the logs generated by handleBatch(). More...
	setRelease ($value)
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 ()

Protected Member Functions
	write (array $record)
	{} More...
	getDefaultFormatter ()
	getDefaultBatchFormatter ()
	Gets the default formatter for the logs generated by handleBatch(). More...
	getExtraParameters ()
	Gets extra parameters supported by Raven that can be found in "extra" and "context". 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
	$ravenClient
	$batchFormatter
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Private Attributes
	$logLevels
	Translates Monolog log levels to Raven log levels. More...
	$release

Detailed Description

Handler to send messages to a Sentry (https://github.com/getsentry/sentry) server using raven-php (https://github.com/getsentry/raven-php)

Author

Marc Abramowitz marc@.nosp@m.marc.nosp@m.-abra.nosp@m.mowi.nosp@m.tz.co.nosp@m.m

Definition at line 25 of file RavenHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\RavenHandler::__construct	(	Raven_Client	$ravenClient,
			$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

Raven_Client	$ravenClient
int	$level	The minimum logging level at which this handler will be triggered
Boolean	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 62 of file RavenHandler.php.

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

    {
        parent::__construct($level, $bubble);

        $this->ravenClient = $ravenClient;
    }

Member Function Documentation

getBatchFormatter()

Monolog\Handler\RavenHandler::getBatchFormatter

(

)

Gets the formatter for the logs generated by handleBatch().

Returns

FormatterInterface

Definition at line 122 of file RavenHandler.php.

References Monolog\Handler\RavenHandler\$batchFormatter, and Monolog\Handler\RavenHandler\getDefaultBatchFormatter().

Referenced by Monolog\Handler\RavenHandler\handleBatch().

    {
        if (!$this->batchFormatter) {
            $this->batchFormatter = $this->getDefaultBatchFormatter();
        }

        return $this->batchFormatter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultBatchFormatter()

Monolog\Handler\RavenHandler::getDefaultBatchFormatter ( )

protected

Gets the default formatter for the logs generated by handleBatch().

Returns

FormatterInterface

Definition at line 207 of file RavenHandler.php.

Referenced by Monolog\Handler\RavenHandler\getBatchFormatter().

    {
        return new LineFormatter();
    }

Here is the caller graph for this function:

getDefaultFormatter()

Monolog\Handler\RavenHandler::getDefaultFormatter ( )

protected

Definition at line 197 of file RavenHandler.php.

    {
        return new LineFormatter('[%channel%] %message%');
    }

getExtraParameters()

Monolog\Handler\RavenHandler::getExtraParameters ( )

protected

Gets extra parameters supported by Raven that can be found in "extra" and "context".

Returns

array

Definition at line 217 of file RavenHandler.php.

References array.

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

    {
        return array('checksum', 'release');
    }

Here is the caller graph for this function:

handleBatch()

LineFormatter The formatter to use for the logs generated via Monolog\Handler\RavenHandler::handleBatch

(

array

$records

)

{Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 72 of file RavenHandler.php.

References Monolog\Handler\AbstractHandler\$level, $r, array, Monolog\Handler\RavenHandler\getBatchFormatter(), Monolog\Handler\AbstractProcessingHandler\handle(), Monolog\Handler\AbstractProcessingHandler\processRecord(), and string.

    {
        $level = $this->level;

        // filter records based on their level
        $records = array_filter($records, function ($record) use ($level) {
            return $record['level'] >= $level;
        });

        if (!$records) {
            return;
        }

        // the record with the highest severity is the "main" one
        $record = array_reduce($records, function ($highest, $record) {
            if ($record['level'] >= $highest['level']) {
                return $record;
            }

            return $highest;
        });

        // the other ones are added as a context item
        $logs = array();
        foreach ($records as $r) {
            $logs[] = $this->processRecord($r);
        }

        if ($logs) {
            $record['context']['logs'] = (string) $this->getBatchFormatter()->formatBatch($logs);
        }

        $this->handle($record);
    }

Here is the call graph for this function:

setBatchFormatter()

Monolog\Handler\RavenHandler::setBatchFormatter

(

FormatterInterface

$formatter

)

Sets the formatter for the logs generated by handleBatch().

Parameters

FormatterInterface

$formatter

Definition at line 112 of file RavenHandler.php.

References Monolog\Handler\AbstractHandler\$formatter.

    {
        $this->batchFormatter = $formatter;
    }

setRelease()

Monolog\Handler\RavenHandler::setRelease

(

$value

)

Parameters

string

$value

Definition at line 225 of file RavenHandler.php.

    {
        $this->release = $value;

        return $this;
    }

write()

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

protected

{}

Definition at line 134 of file RavenHandler.php.

References $key, $options, Monolog\Handler\RavenHandler\$release, $source, array, and Monolog\Handler\RavenHandler\getExtraParameters().

    {
        $previousUserContext = false;
        $options = array();
        $options['level'] = $this->logLevels[$record['level']];
        $options['tags'] = array();
        if (!empty($record['extra']['tags'])) {
            $options['tags'] = array_merge($options['tags'], $record['extra']['tags']);
            unset($record['extra']['tags']);
        }
        if (!empty($record['context']['tags'])) {
            $options['tags'] = array_merge($options['tags'], $record['context']['tags']);
            unset($record['context']['tags']);
        }
        if (!empty($record['context']['fingerprint'])) {
            $options['fingerprint'] = $record['context']['fingerprint'];
            unset($record['context']['fingerprint']);
        }
        if (!empty($record['context']['logger'])) {
            $options['logger'] = $record['context']['logger'];
            unset($record['context']['logger']);
        } else {
            $options['logger'] = $record['channel'];
        }
        foreach ($this->getExtraParameters() as $key) {
            foreach (array('extra', 'context') as $source) {
                if (!empty($record[$source][$key])) {
                    $options[$key] = $record[$source][$key];
                    unset($record[$source][$key]);
                }
            }
        }
        if (!empty($record['context'])) {
            $options['extra']['context'] = $record['context'];
            if (!empty($record['context']['user'])) {
                $previousUserContext = $this->ravenClient->context->user;
                $this->ravenClient->user_context($record['context']['user']);
                unset($options['extra']['context']['user']);
            }
        }
        if (!empty($record['extra'])) {
            $options['extra']['extra'] = $record['extra'];
        }

        if (!empty($this->release) && !isset($options['release'])) {
            $options['release'] = $this->release;
        }

        if (isset($record['context']['exception']) && $record['context']['exception'] instanceof \Exception) {
            $options['extra']['message'] = $record['formatted'];
            $this->ravenClient->captureException($record['context']['exception'], $options);
        } else {
            $this->ravenClient->captureMessage($record['formatted'], array(), $options);
        }

        if ($previousUserContext !== false) {
            $this->ravenClient->user_context($previousUserContext);
        }
    }

Here is the call graph for this function:

Field Documentation

$batchFormatter

Monolog\Handler\RavenHandler::$batchFormatter

protected

Definition at line 55 of file RavenHandler.php.

Referenced by Monolog\Handler\RavenHandler\getBatchFormatter().

$logLevels

Monolog\Handler\RavenHandler::$logLevels

private

Initial value:

= array(
        Logger::DEBUG     => Raven_Client::DEBUG,
        Logger::INFO      => Raven_Client::INFO,
        Logger::NOTICE    => Raven_Client::INFO,
        Logger::WARNING   => Raven_Client::WARNING,
        Logger::ERROR     => Raven_Client::ERROR,
        Logger::CRITICAL  => Raven_Client::FATAL,
        Logger::ALERT     => Raven_Client::FATAL,
        Logger::EMERGENCY => Raven_Client::FATAL,
    )

Translates Monolog log levels to Raven log levels.

Definition at line 30 of file RavenHandler.php.

$ravenClient

Monolog\Handler\RavenHandler::$ravenClient

protected

Definition at line 50 of file RavenHandler.php.

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

$release

Monolog\Handler\RavenHandler::$release

private

Definition at line 45 of file RavenHandler.php.

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

---

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

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