hatchetaustralia/laravel-cloudwatch-logger

Laravel logger for AWS Clouldwatch Log service.

v3.0.0 2022-08-15 00:40 UTC

Requires

• php: ^7.3|^8.0
• illuminate/support: ^7.0|^8.0|^9.0
• maxbanton/cwh: ^2.0

Requires (Dev)

• orchestra/testbench: ^5.0|^6.0
• phpunit/phpunit: ^9.3

MIT

• Turan Karatuğ
• Faruk Can
• Emre Deligöz
• Hakan Özdemir
• Matt Hare

• laravel
• cloudwatch
• laravel-cloudwatch-logger
• hatchet
• hatchetaustralia

README

Laravel logger factory for AWS Cloudwatch Logs service.

Installation

You can install the package via composer:

composer require hatchetaustralia/laravel-cloudwatch-logger

Usage

Config parameters for logging are defined at config/logging.php.

You need to add new channel as cloudwatch and copy params inside config/config.php into it.

'channels' => [
    ...

    'cloudwatch' => [
        'driver' => 'custom',
        'via' => \Hatchet\LaravelCloudWatchLogger\LaravelCloudWatchLoggerFactory::class,
        'aws' => [
            'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
            'version' => 'latest',
            'credentials' => [
                'key' => env('AWS_ACCESS_KEY_ID'),
                'secret' => env('AWS_SECRET_ACCESS_KEY'),
            ],
        ],
        'name' => env('CLOUDWATCH_LOG_NAME', ''),
        'group' => env('CLOUDWATCH_LOG_GROUP_NAME', env('APP_NAME') . '-' . env('APP_ENV')),
        'stream' => env('CLOUDWATCH_LOG_STREAM', 'default'),
        'retention' => env('CLOUDWATCH_LOG_RETENTION', 7),
        'level' => env('CLOUDWATCH_LOG_LEVEL', 'error'),
        'batch_size' => env('CLOUDWATCH_LOG_BATCH_SIZE', 10000),
        'enabled' => env('CLOUDWATCH_ENABLED', true),
        'extra' => [
            'env' => env('APP_ENV'),
            'php' => PHP_VERSION,
            'laravel' => app()->version(),
        ],
    ],
],

Change the log channel inside .env file with cloudwatch.

LOG_CHANNEL=cloudwatch

You can use Laravel's default Log class to send your logs to CloudWatch.

\Illuminate\Support\Facades\Log::info('user logged in successfully', [
    'id' => 1, 
    'username' => 'JohnDoe', 
    'ip' => '127.0.0.1',
]);

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Turan Karatuğ
• Faruk Can
• Yunus Emre Deligöz
• Hakan Özdemir
• All Contributors

License

The MIT License (MIT). Please see License File for more information.