Documentation

SyslogUdpHandler extends AbstractSyslogHandler
in package

A Handler for logging to a remote syslogd server.

Tags
author

Jesper Skovgaard Nielsen nulpunkt@gmail.com

author

Dominik Kukacka dominik.kukacka@gmail.com

Table of Contents

Constants

RFC3164  = 0
RFC5424  = 1

Properties

$bubble  : mixed
$facilities  : mixed
List of valid log facility names.
$facility  : mixed
$formatter  : FormatterInterface
$ident  : mixed
$level  : mixed
$logLevels  : mixed
Translates Monolog log levels to syslog log priorities.
$processors  : mixed
$rfc  : mixed
$socket  : mixed
$dateFormats  : mixed

Methods

__construct()  : mixed
__destruct()  : mixed
close()  : mixed
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
handle()  : bool
Handles a record.
handleBatch()  : mixed
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
Removes the processor on top of the stack and returns it.
pushProcessor()  : self
Adds a processor in the stack.
reset()  : mixed
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : self
Sets the formatter.
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
setSocket()  : mixed
Inject your own socket, mainly used for testing
getDateTime()  : mixed
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
makeCommonSyslogHeader()  : mixed
Make common syslog header (see rfc5424 or rfc3164)
processRecord()  : array<string|int, mixed>
Processes a record.
write()  : void
Writes the record down to the log of the implementing handler
splitMessageIntoLines()  : mixed

Constants

Properties

$facilities

List of valid log facility names.

protected mixed $facilities = array('auth' => LOG_AUTH, 'authpriv' => LOG_AUTHPRIV, 'cron' => LOG_CRON, 'daemon' => LOG_DAEMON, 'kern' => LOG_KERN, 'lpr' => LOG_LPR, 'mail' => LOG_MAIL, 'news' => LOG_NEWS, 'syslog' => LOG_SYSLOG, 'user' => LOG_USER, 'uucp' => LOG_UUCP)

$logLevels

Translates Monolog log levels to syslog log priorities.

protected mixed $logLevels = array(\Monolog\Logger::DEBUG => LOG_DEBUG, \Monolog\Logger::INFO => LOG_INFO, \Monolog\Logger::NOTICE => LOG_NOTICE, \Monolog\Logger::WARNING => LOG_WARNING, \Monolog\Logger::ERROR => LOG_ERR, \Monolog\Logger::CRITICAL => LOG_CRIT, \Monolog\Logger::ALERT => LOG_ALERT, \Monolog\Logger::EMERGENCY => LOG_EMERG)

$dateFormats

private mixed $dateFormats = array(self::RFC3164 => 'M d H:i:s', self::RFC5424 => \DateTime::RFC3339)

Methods

__construct()

public __construct(string $host[, int $port = 514 ][, mixed $facility = LOG_USER ][, int $level = Logger::DEBUG ][, bool $bubble = true ][, string $ident = 'php' ][, int $rfc = self::RFC5424 ]) : mixed
Parameters
$host : string
$port : int = 514
$facility : mixed = LOG_USER
$level : int = Logger::DEBUG

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

$ident : string = 'php'

Program name or tag for each log message.

$rfc : int = self::RFC5424

RFC to format the message for.

close()

Closes the handler.

public close() : mixed

This will be called automatically when the object is destroyed

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Return values
int

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

Return values
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.

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

isHandling()

Checks whether the given record will be handled by this handler.

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool

popProcessor()

Removes the processor on top of the stack and returns it.

public popProcessor() : callable
Return values
callable

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(int|string $level) : self
Parameters
$level : int|string

Level or level name

Return values
self

setSocket()

Inject your own socket, mainly used for testing

public setSocket(mixed $socket) : mixed
Parameters
$socket : mixed

makeCommonSyslogHeader()

Make common syslog header (see rfc5424 or rfc3164)

protected makeCommonSyslogHeader(mixed $severity) : mixed
Parameters
$severity : mixed

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Return values
array<string|int, mixed>

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>

splitMessageIntoLines()

private splitMessageIntoLines(mixed $message) : mixed
Parameters
$message : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results