Class SyslogLog
Syslog stream for Logging. Writes logs to the system logger
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this class
-
$_levelMap protected
arrayUsed to map the string names back to their LOG_* constants
-
$_open protected
boolWhether the logger connection is open or not
Method Summary
-
__construct() public
__construct method
-
__destruct() public
Closes the logger connection
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_format() protected
Converts to string the provided data so it can be logged. The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.
-
_open() protected
Extracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger
-
_write() protected
Extracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger
-
alert() public
Action must be taken immediately.
-
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
critical() public
Critical conditions.
-
debug() public
Detailed debug information.
-
emergency() public
System is unusable.
-
error() public
Runtime errors that do not require immediate action but should typically be logged and monitored.
-
info() public
Interesting events.
-
levels() public
Get the levels this logger is interested in.
-
log() public
Writes a message to syslog
-
notice() public
Normal but significant events.
-
scopes() public
Get the scopes this logger is interested in.
-
warning() public
Exceptional occurrences that are not errors.
Method Detail
__construct() ¶ public
__construct(array $config = [])__construct method
Parameters
-
array$config optional Configuration array
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_format() ¶ protected
_format(mixed $data, array $context = []): stringConverts to string the provided data so it can be logged. The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.
Parameters
-
mixed$data The data to be converted to string and logged.
-
array$context optional Additional logging information for the message.
Returns
string_open() ¶ protected
_open(string $ident, int $options, int $facility): voidExtracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger
Parameters
-
string$ident the prefix to add to all messages logged
-
int$options the options flags to be used for logged messages
-
int$facility the stream or facility to log to
Returns
void_write() ¶ protected
_write(int $priority, string $message): boolExtracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger
Parameters
-
int$priority Message priority.
-
string$message Message to log.
Returns
boolalert() ¶ public
alert(string $message, mixed[] $context = array()): voidAction must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thiscritical() ¶ public
critical(string $message, mixed[] $context = array()): voidCritical conditions.
Example: Application component unavailable, unexpected exception.
Parameters
-
string$message -
mixed[]$context optional
Returns
voiddebug() ¶ public
debug(string $message, mixed[] $context = array()): voidDetailed debug information.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidemergency() ¶ public
emergency(string $message, mixed[] $context = array()): voidSystem is unusable.
Parameters
-
string$message -
mixed[]$context optional
Returns
voiderror() ¶ public
error(string $message, mixed[] $context = array()): voidRuntime errors that do not require immediate action but should typically be logged and monitored.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidinfo() ¶ public
info(string $message, mixed[] $context = array()): voidInteresting events.
Example: User logs in, SQL logs.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidlog() ¶ public
log(mixed $level, string $message, mixed[] $context = []): boolWrites a message to syslog
Map the $level back to a LOG_ constant value, split multi-line messages into multiple log messages, pass all messages through the format defined in the configuration
Parameters
-
mixed$level The severity level of log you are making.
-
string$message The message you want to log.
-
mixed[]$context optional Additional information about the logged message
Returns
boolnotice() ¶ public
notice(string $message, mixed[] $context = array()): voidNormal but significant events.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidwarning() ¶ public
warning(string $message, mixed[] $context = array()): voidExceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
Parameters
-
string$message -
mixed[]$context optional
Returns
voidProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Default config for this class
By default messages are formatted as: level: message
To override the log format (e.g. to add your own info) define the format key when configuring this logger
If you wish to include a prefix to all messages, for instance to identify the application or the web server, then use the prefix option. Please keep in mind the prefix is shared by all streams using syslog, as it is dependent of the running process. For a local prefix, to be used only by one stream, you can use the format key.
Example:
Log::config('error', ]
'engine' => 'Syslog',
'levels' => ['emergency', 'alert', 'critical', 'error'],
'format' => "%s: My-App - %s",
'prefix' => 'Web Server 01'
]);Type
array