https://github.com/brefphp/logger
All you need to log with Bref on AWS Lambda.
https://github.com/brefphp/logger
aws-lambda bref logger psr-3 serverless
Last synced: about 1 month ago
JSON representation
All you need to log with Bref on AWS Lambda.
- Host: GitHub
- URL: https://github.com/brefphp/logger
- Owner: brefphp
- License: mit
- Created: 2019-03-06T22:59:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-07T12:45:17.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T20:22:19.016Z (about 1 month ago)
- Topics: aws-lambda, bref, logger, psr-3, serverless
- Language: PHP
- Homepage: https://bref.sh/docs/environment/logs.html
- Size: 17.6 KB
- Stars: 34
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
All you need to log with [Bref](https://bref.sh) on AWS Lambda.
[](https://travis-ci.com/brefphp/logger)
[](https://packagist.org/packages/bref/logger)
Bref/Logger is a lightweight [PSR-3](https://www.php-fig.org/psr/psr-3/) logger for AWS Lambda. Messages are sent to `stderr` so that they end up in [CloudWatch](https://bref.sh/docs/environment/logs.html).
## Why?
As explained in [the Bref documentation](https://bref.sh/docs/environment/logs.html), logging in AWS Lambda means logging to `stderr`. Logs written to `stderr` are automatically sent to [CloudWatch](https://aws.amazon.com/cloudwatch/), AWS' solution to collect and view logs.
While classic loggers like [Monolog](https://github.com/Seldaek/monolog) work fine, this logger comes as a simpler and lighter alternative optimized for AWS Lambda. It does not require any configuration and currently contains a single class.
Since it is [PSR-3](https://www.php-fig.org/psr/psr-3/) compliant, Bref/Logger is also compatible with any framework or library consuming a PSR-3 logger.
## Installation
```
composer require bref/logger
```
## Usage
The logger does not require any configuration:
```php
$logger = new \Bref\Logger\StderrLogger();
```
By default messages **above the `warning` level** will be logged, the rest will be discarded.
It is possible to log using any [PSR-3 log level](https://www.php-fig.org/psr/psr-3/#5-psrlogloglevel), the most common ones being:
```php
$logger->debug('This is a debug message');
$logger->info('This is an info');
$logger->warning('This is a warning');
$logger->error('This is an error');
```
```
[WARNING] This is a warning
[ERROR] This is an error
```
Messages under `warning` are not logged.
### Message placeholders
[PSR-3 placeholders](https://www.php-fig.org/psr/psr-3/#12-message) can be used to insert information from the `$context` array into the message without having to concatenate strings manually:
```php
$logger->warning('Invalid login attempt for email {email}', [
'email' => $email,
]);
```
```
[WARNING] Invalid login attempt for email [email protected]
```
### Logging exceptions
Exceptions [can be logged](https://www.php-fig.org/psr/psr-3/#13-context) under the `exception` key:
```php
try {
// ...
} catch (\Exception $e) {
$logger->error('Impossible to complete the action', [
'exception' => $e,
]);
}
```
```
[ERROR] Impossible to complete the action
InvalidArgumentException: Impossible to complete the action in /var/task/index.php:12
Stack trace:
#0 /var/task/index.php(86): main()
...
```
### Log level
It is possible to change the level above which messages are logged.
For example to log all messages:
```php
$logger = new \Bref\Logger\StderrLogger(\Psr\Log\LogLevel::DEBUG);
```