Class SyslogLog
Syslog stream for Logging. Writes logs to the system logger
- Psr\Log\AbstractLogger
-
Cake\Log\Engine\BaseLog
uses
Cake\Core\InstanceConfigTrait
-
Cake\Log\Engine\SyslogLog
Properties summary
-
$_defaultConfigprotectedarrayDefault config for this class -
$_levelMapprotectedint[]Used to map the string names back to their LOG_* constants -
$_openprotectedbooleanWhether the logger connection is open or not
Inherited Properties
Method Summary
-
__destruct() public
Closes the logger connection -
_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
-
log() public
Writes a message to syslog
Method Detail
_open() protected ¶
_open( string $ident , integer $options , integer $facility )
Extracts 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
- integer $options
- the options flags to be used for logged messages
- integer $facility
- the stream or facility to log to
_write() protected ¶
_write( integer $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
Parameters
- integer $priority
- Message priority.
- string $message
- Message to log.
Returns
log() public ¶
log( string $level , string $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
Parameters
- string $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
Returns
success of write.
Methods inherited from Cake\Log\Engine\BaseLog
__construct() public ¶
__construct( array $config [] )
__construct method
Parameters
- array $config optional []
- Configuration array
_format() protected ¶
_format( mixed $data , array $context [] )
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.
Parameters
- mixed $data
- The data to be converted to string and logged.
- array $context optional []
- Additional logging information for the message.
Returns
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default null )
Returns the config.
Usage
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');
Parameters
- string|null $key optional null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
Usage
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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
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' ]);
[
'levels' => [],
'scopes' => [],
'format' => '%s: %s',
'flag' => LOG_ODELAY,
'prefix' => '',
'facility' => LOG_USER
]
$_levelMap ¶
Used to map the string names back to their LOG_* constants
[
'emergency' => LOG_EMERG,
'alert' => LOG_ALERT,
'critical' => LOG_CRIT,
'error' => LOG_ERR,
'warning' => LOG_WARNING,
'notice' => LOG_NOTICE,
'info' => LOG_INFO,
'debug' => LOG_DEBUG
]