Syslog stream for Logging. Writes logs to the system logger
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config for this class
int[]Used to map the string names back to their LOG_* constants
boolWhether the logger connection is open or not
Extracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger
Extracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Runtime errors that do not require immediate action but should typically be logged and monitored.
__construct(array $config)
__construct method
array $config optional Configuration array
__destruct()
Closes the logger connection
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception_format(string $message, array $context)
Formats the message to be logged.
The context can optionally be used by log engines to interpolate variables or add additional info to the logged message.
string $message The message to be formatted.
array $context optional Additional logging information for the message.
string_getFormattedDate()
Returns date formatted according to given dateFormat option format.
This function affects FileLog orConsoleLog datetime information format.
string_open(string $ident, int $options, int $facility)
Extracts the call to openlog() in order to run unit tests on it. This function will initialize the connection to the system logger
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
_write(int $priority, string $message)
Extracts the call to syslog() in order to run unit tests on it. This function will perform the actual write in the system logger
int $priority Message priority.
string $message Message to log.
boolalert(mixed $message, array $context)
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
string $message array $context optional configShallow(mixed $key, mixed $value)
Merge 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->configShallow('key', $value); Setting a nested value:
$this->configShallow('some.nested.key', $value); Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thiscritical(mixed $message, array $context)
Critical conditions.
Example: Application component unavailable, unexpected exception.
string $message array $context optional debug(mixed $message, array $context)
Detailed debug information.
string $message array $context optional emergency(mixed $message, array $context)
System is unusable.
string $message array $context optional error(mixed $message, array $context)
Runtime errors that do not require immediate action but should typically be logged and monitored.
string $message array $context optional getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key'); Reading a nested value:
$this->getConfig('some.nested.key'); Reading with default value:
$this->getConfig('some-key', 'default-value'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptioninfo(mixed $message, array $context)
Interesting events.
Example: User logs in, SQL logs.
string $message array $context optional levels()
Get the levels this logger is interested in.
arraylog(mixed $level, mixed $message, array $context)
Writes 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
mixed $level The severity level of log you are making.
string $message The message you want to log.
array $context optional Additional information about the logged message
notice(mixed $message, array $context)
Normal but significant events.
string $message array $context optional scopes()
Get the scopes this logger is interested in.
array|falsesetConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value); Setting a nested value:
$this->setConfig('some.nested.key', $value); Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array $key The key to 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.
$thisCake\Core\Exception\Exceptionwarning(mixed $message, array $context)
Exceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.
string $message array $context optional Runtime config
arrayWhether the config property has already been configured with defaults
boolDefault 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.
Log::config('error', ]
'engine' => 'Syslog',
'levels' => ['emergency', 'alert', 'critical', 'error'],
'format' => "%s: My-App - %s",
'prefix' => 'Web Server 01'
]); arrayUsed to map the string names back to their LOG_* constants
int[]Whether the logger connection is open or not
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Log.Engine.SyslogLog.html