felixmaier1989/maxbanton-cwh

AWS CloudWatch Handler for Monolog library

AWS CloudWatch Logs Handler for Monolog

, _(*1)

Handler for PHP logging library Monolog for sending log entries to AWS CloudWatch Logs service., _(*2)

Before using this library, it's recommended to get acquainted with the pricing for AWS CloudWatch services., _(*3)

Please press ★ Star button if you find this library useful, aslo you can donate if you like to., _(*4)

Features

• Up to 10000 batch logs sending in order to avoid Rate exceeded errors
• Log Groups creating with tags
• AWS CloudWatch Logs staff lazy loading
• Suitable for web applications and for long-living CLI daemons and workers
• Compatible with PHP 5.6 / 7.0 / 7.1

Installation

Install the latest version with Composer, _(*5)

$ composer require maxbanton/cwh:^1.0

Upgrade

Change in your composer.json, _(*6)

{
  "require": {
    "maxbanton/cwh": "^0.0.3"
  }
}

to, _(*7)

{
  "require": {
    "maxbanton/cwh": "^1.0"
  }
}

then run, _(*8)

$ composer update

and change your code, _(*9)

<?php
// Instantiate handler
$handler = new CloudWatch($client, $logGroupName, $logStreamName, $daysToRetention);

to, _(*10)

<?php
// Instantiate handler (tags are optional)
$handler = new CloudWatch($client, $groupName, $streamName, $retentionDays, 10000, ['my-awesome-tag' => 'tag-value']);

Basic Usage

<?php

use Aws\CloudWatchLogs\CloudWatchLogsClient;
use Maxbanton\Cwh\Handler\CloudWatch;
use Monolog\Logger;

$sdkParams = [
    'region' => 'eu-west-1',
    'version' => 'latest',
    'credentials' => [
        'key' => 'your AWS key',
        'secret' => 'your AWS secret',
        'token' => 'your AWS session token', // token is optional
    ]
];

// Instantiate AWS SDK CloudWatch Logs Client
$client = new CloudWatchLogsClient($sdkParams);

// Log group name, will be created if none
$groupName = 'php-logtest';

// Log stream name, will be created if none
$streamName = 'ec2-instance-1';

// Days to keep logs, 14 by default
$retentionDays = 30;

// Instantiate handler (tags are optional)
$handler = new CloudWatch($client, $groupName, $streamName, $retentionDays, 10000, ['my-awesome-tag' => 'tag-value']);

// Create a log channel
$log = new Logger('name');

// Set handler
$log->pushHandler($handler);

// Add records to the log
$log->debug('Foo');
$log->warning('Bar');
$log->error('Baz');

Frameworks integration

• Silex
• Symfony (Example)
• Lumen

• Laravel, _(*11)

  And many others, _(*12)

Issues

Feel free to report any issues, _(*13)

Contributing

Please check this document, _(*14)

Donate

If you would like to, you can send any amount of BTC to the wallet 12d3VXfvPiQ5bFMfPppGqpwnNSkZwigBVt, _(*15)