Monolog\Handler\SyslogUdpHandler Class Reference

A Handler for logging to a remote syslogd server. More...

Inheritance diagram for Monolog\Handler\SyslogUdpHandler:

Collaboration diagram for Monolog\Handler\SyslogUdpHandler:

Public Member Functions
	__construct ($host, $port=514, $facility=LOG_USER, $level=Logger::DEBUG, $bubble=true, $ident='php')
	close ()
	setSocket ($socket)
	Inject your own socket, mainly used for testing. More...
Public Member Functions inherited from Monolog\Handler\AbstractSyslogHandler
	__construct ($facility=LOG_USER, $level=Logger::DEBUG, $bubble=true)
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 ()

Protected Member Functions
	write (array $record)
	makeCommonSyslogHeader ($severity)
	Make common syslog header (see rfc5424) More...
	getDateTime ()
Protected Member Functions inherited from Monolog\Handler\AbstractSyslogHandler
	getDefaultFormatter ()
	{} 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
	$socket
	$ident
Protected Attributes inherited from Monolog\Handler\AbstractSyslogHandler
	$facility
	$logLevels
	Translates Monolog log levels to syslog log priorities. More...
	$facilities
	List of valid log facility names. More...
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG
	$bubble = true
	$formatter
	$processors = array()

Private Member Functions
	splitMessageIntoLines ($message)

Detailed Description

A Handler for logging to a remote syslogd server.

Author

Jesper Skovgaard Nielsen nulpu.nosp@m.nkt@.nosp@m.gmail.nosp@m..com

Definition at line 22 of file SyslogUdpHandler.php.

Constructor & Destructor Documentation

__construct()

Monolog\Handler\SyslogUdpHandler::__construct	(		$host,
			$port = 514,
			$facility = LOG_USER,
			$level = Logger::DEBUG,
			$bubble = true,
			$ident = 'php'
	)

Parameters

string	$host
int	$port
mixed	$facility
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
string	$ident	Program name or tag for each log message.

Definition at line 35 of file SyslogUdpHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractSyslogHandler\$facility, Monolog\Handler\SyslogUdpHandler\$ident, and Monolog\Handler\AbstractHandler\$level.

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

        $this->ident = $ident;

        $this->socket = new UdpSocket($host, $port ?: 514);
    }

Member Function Documentation

close()

Monolog\Handler\SyslogUdpHandler::close

(

)

Definition at line 55 of file SyslogUdpHandler.php.

    {
        $this->socket->close();
    }

getDateTime()

Monolog\Handler\SyslogUdpHandler::getDateTime ( )

protected

Definition at line 91 of file SyslogUdpHandler.php.

Referenced by Monolog\Handler\SyslogUdpHandler\makeCommonSyslogHeader().

    {
        return date(\DateTime::RFC3339);
    }

Here is the caller graph for this function:

makeCommonSyslogHeader()

Monolog\Handler\SyslogUdpHandler::makeCommonSyslogHeader (   $severity )

protected

Make common syslog header (see rfc5424)

Definition at line 72 of file SyslogUdpHandler.php.

References Monolog\Handler\AbstractSyslogHandler\$facility, and Monolog\Handler\SyslogUdpHandler\getDateTime().

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

    {
        $priority = $severity + $this->facility;

        if (!$pid = getmypid()) {
            $pid = '-';
        }

        if (!$hostname = gethostname()) {
            $hostname = '-';
        }

        return "<$priority>1 " .
            $this->getDateTime() . " " .
            $hostname . " " .
            $this->ident . " " .
            $pid . " - - ";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSocket()

Monolog\Handler\SyslogUdpHandler::setSocket

(

$socket

)

Inject your own socket, mainly used for testing.

Definition at line 99 of file SyslogUdpHandler.php.

References Monolog\Handler\SyslogUdpHandler\$socket.

    {
        $this->socket = $socket;
    }

splitMessageIntoLines()

Monolog\Handler\SyslogUdpHandler::splitMessageIntoLines (   $message )

private

Definition at line 60 of file SyslogUdpHandler.php.

References $message.

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

    {
        if (is_array($message)) {
            $message = implode("\n", $message);
        }

        return preg_split('/$\R?^/m', $message, -1, PREG_SPLIT_NO_EMPTY);
    }

Here is the caller graph for this function:

write()

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

protected

Definition at line 44 of file SyslogUdpHandler.php.

References $header, Monolog\Handler\SyslogUdpHandler\makeCommonSyslogHeader(), and Monolog\Handler\SyslogUdpHandler\splitMessageIntoLines().

    {
        $lines = $this->splitMessageIntoLines($record['formatted']);

        $header = $this->makeCommonSyslogHeader($this->logLevels[$record['level']]);

        foreach ($lines as $line) {
            $this->socket->write($line, $header);
        }
    }

Here is the call graph for this function:

Field Documentation

$ident

Monolog\Handler\SyslogUdpHandler::$ident

protected

Definition at line 25 of file SyslogUdpHandler.php.

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

$socket

Monolog\Handler\SyslogUdpHandler::$socket

protected

Definition at line 24 of file SyslogUdpHandler.php.

Referenced by Monolog\Handler\SyslogUdpHandler\setSocket().

---

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

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