SyslogHandler
extends AbstractSyslogHandler
in package
Logs to syslog service.
usage example:
$log = new Logger('application'); $syslog = new SyslogHandler('myfacility', 'local6'); $formatter = new LineFormatter("%channel%.%level_name%: %message% %extra%"); $syslog->setFormatter($formatter); $log->pushHandler($syslog);
Tags
Table of Contents
- $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.
- $logopts : mixed
- $processors : mixed
- __construct() : mixed
- __destruct() : mixed
- close() : mixed
- {@inheritdoc}
- 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() : mixed
- {@inheritdoc}
- 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.
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
- processRecord() : array<string|int, mixed>
- Processes a record.
- write() : mixed
- {@inheritdoc}
Properties
$bubble
protected
mixed
$bubble
= true
$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)
$facility
protected
mixed
$facility
$formatter
protected
FormatterInterface
$formatter
$ident
protected
mixed
$ident
$level
protected
mixed
$level
= MonologLogger::DEBUG
$logLevels
Translates Monolog log levels to syslog log priorities.
protected
mixed
$logLevels
= array(MonologLogger::DEBUG => LOG_DEBUG, MonologLogger::INFO => LOG_INFO, MonologLogger::NOTICE => LOG_NOTICE, MonologLogger::WARNING => LOG_WARNING, MonologLogger::ERROR => LOG_ERR, MonologLogger::CRITICAL => LOG_CRIT, MonologLogger::ALERT => LOG_ALERT, MonologLogger::EMERGENCY => LOG_EMERG)
$logopts
protected
mixed
$logopts
$processors
protected
mixed
$processors
= array()
Methods
__construct()
public
__construct(string $ident[, mixed $facility = LOG_USER ][, int $level = Logger::DEBUG ][, bool $bubble = true ][, int $logopts = LOG_PID ]) : mixed
Parameters
- $ident : string
- $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
- $logopts : int = LOG_PID
-
Option flags for the openlog() call, defaults to LOG_PID
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —close()
{@inheritdoc}
public
close() : mixed
Return values
mixed —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.
getFormatter()
Gets the formatter.
public
getFormatter() : FormatterInterface
Return values
FormatterInterface —getLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Return values
int —handle()
{@inheritdoc}
public
handle(array<string|int, mixed> $record) : mixed
Parameters
- $record : array<string|int, mixed>
Return values
mixed —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)
Return values
mixed —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 —reset()
public
reset() : mixed
Return values
mixed —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 —setFormatter()
Sets the formatter.
public
setFormatter(FormatterInterface $formatter) : self
Parameters
- $formatter : FormatterInterface
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 —getDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface
Return values
FormatterInterface —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()
{@inheritdoc}
protected
write(array<string|int, mixed> $record) : mixed
Parameters
- $record : array<string|int, mixed>