Skip to content

Commit

Permalink
Merge pull request #16654 from cakephp/log-readme
Browse files Browse the repository at this point in the history
Fix outdated Log Readme
  • Loading branch information
ADmad committed Jul 29, 2022
2 parents 5dee79a + 8e273ef commit c60b422
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/Log/README.md
Expand Up @@ -8,26 +8,26 @@ multiple logging backends using a simple interface. With the `Log` class it is
possible to send a single message to multiple logging backends at the same time
or just a subset of them based on the log level or context.

By default, you can use Files or Syslog as logging backends, but you can use any
By default, you can use `File` or `Syslog` as logging backends, but you can use any
object implementing `Psr\Log\LoggerInterface` as an engine for the `Log` class.

## Usage

You can define as many or as few loggers as your application needs. Loggers
should be configured using `Cake\Core\Log.` An example would be:
should be configured using `Cake\Log\Log.` An example would be:

```php
use Cake\Log\Log;

// Short classname
Log::config('local', [
'className' => 'FileLog',
Log::setConfig('local', [
'className' => 'File',
'levels' => ['notice', 'info', 'debug'],
'file' => '/path/to/file.log',
]);

// Fully namespaced name.
Log::config('production', [
Log::setConfig('production', [
'className' => \Cake\Log\Engine\SyslogLog::class,
'levels' => ['warning', 'error', 'critical', 'alert', 'emergency'],
]);
Expand All @@ -36,7 +36,7 @@ Log::config('production', [
It is also possible to create loggers by providing a closure.

```php
Log::config('special', function () {
Log::setConfig('special', function () {
// Return any PSR-3 compatible logger
return new MyPSR3CompatibleLogger();
});
Expand All @@ -45,7 +45,7 @@ Log::config('special', function () {
Or by injecting an instance directly:

```php
Log::config('special', new MyPSR3CompatibleLogger());
Log::setConfig('special', new MyPSR3CompatibleLogger());
```

You can then use the `Log` class to pass messages to the logging backends:
Expand All @@ -66,8 +66,8 @@ you can limit the logging engines that receive a particular message.
```php
// Configure /logs/payments.log to receive all levels, but only
// those with `payments` scope.
Log::config('payments', [
'className' => 'FileLog',
Log::setConfig('payments', [
'className' => 'File',
'levels' => ['error', 'info', 'warning'],
'scopes' => ['payments'],
'file' => '/logs/payments.log',
Expand Down

0 comments on commit c60b422

Please sign in to comment.