kentaroutakeda/laravel-cloudwatch-logs

Laravel Adapter for AWS CloudWatch

v1.1.3 2025-03-30 00:43 UTC

Requires

• illuminate/support: ^5.1 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0
• phpnexus/cwh: ^1.1.14 || ^2.0 || ^3.0.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12 || ^2.16|^3.14
• mockery/mockery: ^1.2
• phpunit/phpunit: ^6.5 || ^8.4 || ^9.0 || ^10.5

MIT

• Naren Chitrakar
• Sujan Shrestha

README

Installation

composer require kentaroutakeda/laravel-cloudwatch-logs

Example

You can use laravel's default \Log class to use this

\Log::info('user logged in', ['id' => 123, 'name' => 'Naren']);

Usage with AWS Lambda

Make sure the AWS Lambda template contains an IAM role with enough access. So think about Logs:CreateLogGroup, Logs:DescribeLogGroups, Logs:CreateLogStream, Logs:DescribeLogStream, Logs:PutRetentionPolicy and Logs:PutLogEvents

Config

Config for logging is defined at config/logging.php. Add cloudwatch to the channels array

'channels' =>  [
    'cloudwatch' => [
        'driver' => 'custom',
        'name' => env('CLOUDWATCH_LOG_NAME', ''),
        'region' => env('CLOUDWATCH_LOG_REGION', ''),
        'credentials' => [
            'key' => env('CLOUDWATCH_LOG_KEY', ''),
            'secret' => env('CLOUDWATCH_LOG_SECRET', '')
        ],
        'stream_name' => env('CLOUDWATCH_LOG_STREAM_NAME', 'laravel_app'),
        'retention' => env('CLOUDWATCH_LOG_RETENTION_DAYS', 14),
        'group_name' => env('CLOUDWATCH_LOG_GROUP_NAME', 'laravel_app'),
        'version' => env('CLOUDWATCH_LOG_VERSION', 'latest'),
        'formatter' => \Monolog\Formatter\JsonFormatter::class,
        'batch_size' => env('CLOUDWATCH_LOG_BATCH_SIZE', 10000),
        'level' => env('CLOUDWATCH_LOG_LEVEL', 'info'),
        'via' => \Pagevamp\Logger::class,
    ],
]

And set the LOG_CHANNEL in your environment variable to cloudwatch.

If the role of your AWS EC2 instance has access to Cloudwatch logs, CLOUDWATCH_LOG_KEY and CLOUDWATCH_LOG_SECRET need not be defined in your .env file.

Contribution

I have added a pre-commit hook to run php-cs-fixer whenever you make a commit. To enable this run sh hooks.sh.