santiripper/watchtower

Watchtower is a Laravel wrapper for sending custom metrics to Amazon AWS CloudWatch in a really pleasant & powerful way.

Watchtower

, _(*1)

Watchtower is a Laravel wrapper for sending custom metrics to Amazon AWS CloudWatch in a really pleasant & powerful way., _(*2)

Be sure to read the CloudWatch docs first., _(*3)

Requirements

• PHP >= 5.6
• Laravel >= 5.1
• Laravel AWS SDK >= 3
• An Amazon AWS Cloudwatch account

Installation

Via Composer by running, _(*4)

composer require santiripper/watchtower

Or editing composer.json, _(*5)

{
    "require": {
        "santiripper/watchtower" : "dev-master"
    }
}

To use the Watchtower Service Provider, you must register the provider when bootstrapping your Laravel application., _(*6)

Find the providers key in your config/app.php and register the Watchtower Service Provider., _(*7)

'providers' => array(
    // ...
    Santiripper\Watchtower\WatchtowerServiceProvider::class,
)

Optional, find the aliases key in your config/app.php and register the Watchtower Service Provider., _(*8)

'aliases' => array(
    // ...
    'Watchtower' => Santiripper\Watchtower\Facade::class`
)

Configuration

Publish the config file by running, _(*9)

php artisan vendor:publish --tag=watchtower

It will create the file app/config/watchtower.php, _(*10)

Be sure to configure the Laravel AWS PHP SDK properly (regions & credentials), _(*11)

Usage

You can usage it via helper function, _(*12)

cloudwatch()->on(...);

Or by facade, _(*13)

Cloudwatch::on(...);

Namespaces

Watchtower supports multiple Cloudwatch namespaces. To select the namespace of the metric you have to specify it using the method on, for ex if our namespace is called AwesomeApp:, _(*14)

$awesomeApp = cloudwatch()->on('AwesomeApp');

Facade way:, _(*15)

$awesomeApp = Cloudwatch::on('AwesomeApp');

Also you can use the helper shortcut by passing the metric namespace as parameter to the main function:, _(*16)

$awesomeApp = cloudwatch('AwesomeApp');

Adding metrics

$dimensions = [
    cloudwatch()->dimension('NameDimension1', 'ValueDimension2'),
    cloudwatch()->dimension('NameDimension1', 'ValueDimension2'),
];
$awesomeApp->newMetric('MetricName', 14, 'Count', $dimensions);

Setting default dimensions

You can configure default metric dimensions on namespaces that will be included on all related metrics., _(*17)

Programatically:, _(*18)

$dimension = watchtower()->dimension('name', 'value');
$awesomeApp->addDefaultDimension($dimension);

Or by config on the conig/watchtower.php file:, _(*19)

'default_dimensions' => [
    'on' => [
        //Namespace
        'AwesomeApp' => [
            ['name' => 'test_name_1', 'value' => 'test_value_2'],
            ['name' => 'test_name_2', 'value' => 'test_value_2'],
        ],
    ],
],

Sending

By defaults, watchtower queues metrics on memory and sends it automatically when the scripts shutdown. You can configure this behavior on the watchtower config., _(*20)

If you need to send the metrics at the moment you can do it by executing the sent method:, _(*21)

cloudwatch()->send();

ToDo

• [ ] Add StatisticValues support
• [ ] Add support to output to aws console
• [ ] Write tests