Syslog stream for Logging. Writes logs to the system logger
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default config for this class
array<int>
Used to map the string names back to their LOG_* constants
bool
Whether the logger connection is open or not
Cake\Log\Formatter\AbstractFormatter
__construct method
Closes the logger connection
Deletes a single config key.
Reads a config key.
Writes a config key.
Formats the message to be logged.
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
Action must be taken immediately.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Critical conditions.
Detailed debug information.
System is unusable.
Runtime errors that do not require immediate action but should typically be logged and monitored.
Returns the config.
Returns the config for this specific key.
Interesting events.
Replaces placeholders in message string with context values.
Get the levels this logger is interested in.
Writes a message to syslog
Normal but significant events.
Get the scopes this logger is interested in.
Sets the config.
Exceptional occurrences that are not errors.
__construct(array<string, mixed> $config = [])
__construct method
array<string, mixed>
$config optional __destruct()
Closes the logger connection
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
_format(string $message, array $context = []): string
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
_open(string $ident, int $options, int $facility): void
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
void
_write(int $priority, string $message): bool
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.
bool
alert(string $message, mixed[] $context = array()): void
Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.
string
$message mixed[]
$context optional void
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
critical(string $message, mixed[] $context = array()): void
Critical conditions.
Example: Application component unavailable, unexpected exception.
string
$message mixed[]
$context optional void
debug(string $message, mixed[] $context = array()): void
Detailed debug information.
string
$message mixed[]
$context optional void
emergency(string $message, mixed[] $context = array()): void
System is unusable.
string
$message mixed[]
$context optional void
error(string $message, mixed[] $context = array()): void
Runtime errors that do not require immediate action but should typically be logged and monitored.
string
$message mixed[]
$context optional void
getConfig(string|null $key = null, mixed $default = null): mixed
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.
mixed
getConfigOrFail(string $key): mixed
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.
mixed
InvalidArgumentException
info(string $message, mixed[] $context = array()): void
Interesting events.
Example: User logs in, SQL logs.
string
$message mixed[]
$context optional void
interpolate(string $message, array $context = []): string
Replaces placeholders in message string with context values.
string
$message Formatted string
array
$context optional Context for placeholder values.
string
levels(): array<string>
Get the levels this logger is interested in.
array<string>
log(mixed $level, string $message, mixed[] $context = []): void
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.
mixed[]
$context optional Additional information about the logged message
void
notice(string $message, mixed[] $context = array()): void
Normal but significant events.
string
$message mixed[]
$context optional void
scopes(): array<string>|false
Get the scopes this logger is interested in.
array<string>|false
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string
$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.
$this
Cake\Core\Exception\CakeException
warning(string $message, mixed[] $context = array()): void
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 mixed[]
$context optional void
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
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.
Log::config('error', ] 'engine' => 'Syslog', 'levels' => ['emergency', 'alert', 'critical', 'error'], 'prefix' => 'Web Server 01' ]);
array<string, mixed>
Used to map the string names back to their LOG_* constants
array<int>
Whether the logger connection is open or not
bool
Cake\Log\Formatter\AbstractFormatter
© 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.4/class-Cake.Log.Engine.SyslogLog.html