Monolog\Handler\GelfHandler Class Reference

Handler to send messages to a Graylog2 (http://www.graylog2.org) server. More...

Inheritance diagram for Monolog\Handler\GelfHandler:

Collaboration diagram for Monolog\Handler\GelfHandler:

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

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

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

Detailed Description

Handler to send messages to a Graylog2 (http://www.graylog2.org) server.

Author

Matt Lehner mlehn.nosp@m.er@g.nosp@m.mail..nosp@m.com

Benjamin Zikarsky benja.nosp@m.min@.nosp@m.zikar.nosp@m.sky..nosp@m.de

Definition at line 27 of file GelfHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\GelfHandler::__construct	(		$publisher,
			$level = Logger::DEBUG,
			$bubble = true
	)

Parameters

PublisherInterface | IMessagePublisher | Publisher	$publisher	a publisher object
integer	$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 39 of file GelfHandler.php.

    {
        parent::__construct($level, $bubble);
 
        if (!$publisher instanceof Publisher && !$publisher instanceof IMessagePublisher && !$publisher instanceof PublisherInterface) {
            throw new InvalidArgumentException("Invalid publisher, expected a Gelf\Publisher, Gelf\IMessagePublisher or Gelf\PublisherInterface instance");
        }
 
        $this->publisher = $publisher;
    }

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

Member Function Documentation

close()

Monolog\Handler\GelfHandler::close

(

)

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

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 53 of file GelfHandler.php.

    {
        $this->publisher = null;
    }

getDefaultFormatter()

Monolog\Handler\GelfHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns

FormatterInterface

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 69 of file GelfHandler.php.

    {
        return new GelfMessageFormatter();
    }

write()

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

    {
        $this->publisher->publish($record['formatted']);
    }

Field Documentation

$publisher

Monolog\Handler\GelfHandler::$publisher

protected

Definition at line 32 of file GelfHandler.php.

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

---

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

• Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/GelfHandler.php