Monolog\Handler\AmqpHandler Class Reference

Inheritance diagram for Monolog\Handler\AmqpHandler:

Collaboration diagram for Monolog\Handler\AmqpHandler:

Public Member Functions
	__construct ($exchange, $exchangeName='log', $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...
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)
	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...

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

Private Member Functions
	getRoutingKey (array $record)
	Gets the routing key for the AMQP exchange. More...
	createAmqpMessage ($data)

Detailed Description

Definition at line 20 of file AmqpHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\AmqpHandler::__construct	(		$exchange,
			$exchangeName = 'log',
			$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

AMQPExchange | AMQPChannel	$exchange	AMQPExchange (php AMQP ext) or PHP AMQP lib channel, ready for use
string	$exchangeName
int	$level
bool	$bubble	Whether the messages that are handled can bubble up the stack or not

Definition at line 38 of file AmqpHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AmqpHandler\$exchange, Monolog\Handler\AmqpHandler\$exchangeName, and Monolog\Handler\AbstractHandler\$level.

    {
        if ($exchange instanceof AMQPExchange) {
            $exchange->setName($exchangeName);
        } elseif ($exchange instanceof AMQPChannel) {
            $this->exchangeName = $exchangeName;
        } else {
            throw new \InvalidArgumentException('PhpAmqpLib\Channel\AMQPChannel or AMQPExchange instance required');
        }
        $this->exchange = $exchange;

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

Member Function Documentation

createAmqpMessage()

Monolog\Handler\AmqpHandler::createAmqpMessage (   $data )

private

Parameters

string

$data

Returns

AMQPMessage

Definition at line 130 of file AmqpHandler.php.

References $data, and array.

Referenced by Monolog\Handler\AmqpHandler\handleBatch(), and Monolog\Handler\AmqpHandler\write().

    {
        return new AMQPMessage(
            (string) $data,
            array(
                'delivery_mode' => 2,
                'content_type' => 'application/json',
            )
        );
    }

Here is the caller graph for this function:

getDefaultFormatter()

Monolog\Handler\AmqpHandler::getDefaultFormatter ( )

protected

Definition at line 144 of file AmqpHandler.php.

References Monolog\Formatter\JsonFormatter\BATCH_MODE_JSON.

    {
        return new JsonFormatter(JsonFormatter::BATCH_MODE_JSON, false);
    }

getRoutingKey()

Monolog\Handler\AmqpHandler::getRoutingKey ( array  $record )

private

Gets the routing key for the AMQP exchange.

Parameters

array

$record

Returns

string

Definition at line 114 of file AmqpHandler.php.

Referenced by Monolog\Handler\AmqpHandler\handleBatch(), and Monolog\Handler\AmqpHandler\write().

    {
        $routingKey = sprintf(
            '%s.%s',
            // TODO 2.0 remove substr call
            substr($record['level_name'], 0, 4),
            $record['channel']
        );

        return strtolower($routingKey);
    }

Here is the caller graph for this function:

handleBatch()

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

References $data, Monolog\Handler\AmqpHandler\createAmqpMessage(), Monolog\Handler\AbstractHandler\getFormatter(), Monolog\Handler\AmqpHandler\getRoutingKey(), Monolog\Handler\AbstractHandler\isHandling(), and Monolog\Handler\AbstractProcessingHandler\processRecord().

    {
        if ($this->exchange instanceof AMQPExchange) {
            parent::handleBatch($records);

            return;
        }

        foreach ($records as $record) {
            if (!$this->isHandling($record)) {
                continue;
            }

            $record = $this->processRecord($record);
            $data = $this->getFormatter()->format($record);

            $this->exchange->batch_basic_publish(
                $this->createAmqpMessage($data),
                $this->exchangeName,
                $this->getRoutingKey($record)
            );
        }

        $this->exchange->publish_batch();
    }

Here is the call graph for this function:

write()

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

protected

Definition at line 55 of file AmqpHandler.php.

References $data, array, Monolog\Handler\AmqpHandler\createAmqpMessage(), and Monolog\Handler\AmqpHandler\getRoutingKey().

    {
        $data = $record["formatted"];
        $routingKey = $this->getRoutingKey($record);

        if ($this->exchange instanceof AMQPExchange) {
            $this->exchange->publish(
                $data,
                $routingKey,
                0,
                array(
                    'delivery_mode' => 2,
                    'content_type' => 'application/json',
                )
            );
        } else {
            $this->exchange->basic_publish(
                $this->createAmqpMessage($data),
                $this->exchangeName,
                $routingKey
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$exchange

AMQPExchange AMQPChannel Monolog\Handler\AmqpHandler::$exchange

protected

Definition at line 25 of file AmqpHandler.php.

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

$exchangeName

Monolog\Handler\AmqpHandler::$exchangeName

protected

Definition at line 30 of file AmqpHandler.php.

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

---

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

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