Logs messages to configured Log adapters. One or more adapters can be configured using Cake Logs's methods. If you don't configure any adapters, and write to Log, the messages will be ignored.
You can configure log adapters in your applications config/app.php file. A sample configuration would look like:
Log::setConfig('my_log', ['className' => 'FileLog']); You can define the className as any fully namespaced classname or use a short hand classname to use loggers in the App\Log\Engine & Cake\Log\Engine namespaces. You can also use plugin short hand to use logging classes provided by plugins.
Log adapters are required to implement Psr\Log\LoggerInterface, and there is a built-in base class (Cake\Log\Engine\BaseLog) that can be used for custom loggers.
Outside of the className key, all other configuration values will be passed to the logging adapter's constructor as an array.
When configuring loggers, you can set which levels a logger will handle. This allows you to disable debug messages in production for example:
Log::setConfig('default', [
'className' => 'File',
'path' => LOGS,
'levels' => ['error', 'critical', 'alert', 'emergency']
]); The above logger would only log error messages or higher. Any other log messages would be discarded.
When configuring loggers you can define the active scopes the logger is for. If defined, only the listed scopes will be handled by the logger. If you don't define any scopes an adapter will catch all scopes that match the handled levels.
Log::setConfig('payments', [
'className' => 'File',
'scopes' => ['payment', 'order']
]); The above logger will only capture log entries made in the payment and order scopes. All other scopes including the undefined scope will be ignored.
You write to the logs using Log::write(). See its documentation for more information.
By default Cake Log supports all the log levels defined in RFC 5424. When logging messages you can either use the named methods, or the correct constants with write():
Log::error('Something horrible happened');
Log::write(LOG_ERR, 'Something horrible happened'); When logging messages and configuring log adapters, you can specify 'scopes' that the logger will handle. You can think of scopes as subsystems in your application that may require different logging setups. For example in an e-commerce application you may want to handle logged errors in the cart and ordering subsystems differently than the rest of the application. By using scopes you can control logging for each part of your application and also use standard log levels.
arrayConfiguration sets.
boolInternal flag for tracking whether or not configuration has been changed.
string[]An array mapping url schemes to fully qualified Log engine class names
arrayLog levels as detailed in RFC 5424 https://tools.ietf.org/html/rfc5424
string[]Handled log levels
\Cake\Log\LogEngineRegistryLogEngineRegistry class
Load the defined configuration and create all the defined logging adapters.
Reset all the connected loggers. This is useful to do when changing the logging configuration or during testing when you want to reset the internal state of the Log class.
This method can be used to define logging adapters for an application or read existing configuration.
_init()
Initializes registry and configurations
_loadConfig()
Load the defined configuration and create all the defined logging adapters.
alert(string $message, mixed $context)
Convenience method to log alert messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
configured()
Returns an array containing the named configurations
string[]Array of configurations.
critical(string $message, mixed $context)
Convenience method to log critical messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
debug(string $message, mixed $context)
Convenience method to log debug messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
drop(string $config)
Drops a constructed adapter.
If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.
If the implementing objects supports a $_registry object the named configuration will also be unloaded from the registry.
string $config An existing configuration you wish to remove.
boolSuccess of the removal, returns false when the config does not exist.
emergency(string $message, mixed $context)
Convenience method to log emergency messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
engine(string $name)
Get a logging engine.
string $name Key name of a configured adapter to get.
\Psr\Log\LoggerInterface|nullInstance of LoggerInterface or false if not found
error(string $message, mixed $context)
Convenience method to log error messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
getConfig(string $key)
Reads existing configuration.
string $key The name of the configuration.
mixed|nullConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Reads existing configuration for a specific key.
The config value for this key must exist, it can never be null.
string $key The name of the configuration.
mixedConfiguration data at the named key.
InvalidArgumentExceptiongetDsnClassMap()
Returns the DSN class map for this class.
string[]info(string $message, mixed $context)
Convenience method to log info messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
levels()
Gets log levels
Call this method to obtain current level configuration.
string[]Active log levels
notice(string $message, mixed $context)
Convenience method to log notice messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
parseDsn(string $dsn)
Parses a DSN into a valid connection configuration
This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:
$dsn = 'mysql://user:pass@localhost/database?'; $config = ConnectionManager::parseDsn($dsn); $dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS'; $config = Log::parseDsn($dsn); $dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null'; $config = Email::parseDsn($dsn); $dsn = 'file:///?className=\My\Cache\Engine\FileEngine'; $config = Cache::parseDsn($dsn); $dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/'; $config = Cache::parseDsn($dsn);
For all classes, the value of scheme is set as the value of both the className unless they have been otherwise specified.
Note that querystring arguments are also parsed and set as values in the returned configuration.
string $dsn The DSN string to convert to a configuration array
arrayThe configuration array to be stored after parsing the DSN
InvalidArgumentExceptionreset()
Reset all the connected loggers. This is useful to do when changing the logging configuration or during testing when you want to reset the internal state of the Log class.
Resets the configured logging adapters, as well as any custom logging levels. This will also clear the configuration data.
setConfig(mixed $key, mixed $config)
This method can be used to define logging adapters for an application or read existing configuration.
To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.
Loggers will not be constructed until the first log message is written.
Setting a cache engine up.
Log::setConfig('default', $settings); Injecting a constructed adapter in:
Log::setConfig('default', $instance); Using a factory function to get an adapter:
Log::setConfig('default', function () { return new FileLog(); }); Configure multiple adapters at once:
Log::setConfig($arrayOfConfig);
string|array $key The name of the logger config, or an array of multiple configs.
array|null $config optional An array of name => config data for adapter.
BadMethodCallExceptionsetDsnClassMap(array $map)
Updates the DSN class map for this class.
string[] $map Additions/edits to the class map to apply.
warning(string $message, mixed $context)
Convenience method to log warning messages
string $message log message
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
write(mixed $level, string $message, mixed $context)
Writes the given message and type to all of the configured log adapters.
Configured adapters are passed both the $level and $message variables. $level is one of the following strings/values.
LOG_EMERG => 'emergency',LOG_ALERT => 'alert',LOG_CRIT => 'critical',LOG_ERR => 'error',LOG_WARNING => 'warning',LOG_NOTICE => 'notice',LOG_INFO => 'info',LOG_DEBUG => 'debug',Write a 'warning' message to the logs:
Log::write('warning', 'Stuff is broken here'); When writing a log message you can define one or many scopes for the message. This allows you to handle messages differently based on application section/feature.
Log::write('warning', 'Payment failed', ['scope' => 'payment']); When configuring loggers you can configure the scopes a particular logger will handle. When using scopes, you must ensure that the level of the message, and the scope of the message intersect with the defined levels & scopes for a logger.
If no configured logger can handle a log message (because of level or scope restrictions) then the logged message will be ignored and silently dropped. You can check if this has happened by inspecting the return of write(). If false the message was not handled.
int|string $level The severity level of the message being written. The value must be an integer or string matching a known level.
string $message Message content to log
string|array $context optional Additional data to be used for logging the message. The special scope key can be passed to be used for further filtering of the log engines to be used. If a string or a numerically index array is passed, it will be treated as the scope key. See Cake\Log\Log::setConfig() for more information on logging scopes.
boolSuccess
InvalidArgumentExceptionConfiguration sets.
arrayInternal flag for tracking whether or not configuration has been changed.
boolAn array mapping url schemes to fully qualified Log engine class names
string[]Handled log levels
string[]LogEngineRegistry class
\Cake\Log\LogEngineRegistry
© 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.Log.html