lsjroberts/datadog-statsd

DataDog Statsd client

PHP DataDog Statsd Client

Forked from https://github.com/DataDog/php-datadogstatsd., _(*1)

Installation

Composer

Add the following to your composer.json:, _(*2)

"lsjroberts/datadog-statsd": "0.1.*"

Setup

Laravel 4

Add the service provider to your Laravel application in app/config/app.php. In the providers array add:, _(*3)

'DataDog\Statsd\StatsdServiceProvider',

And then alias it by adding the facade to the facades array in the same file:, _(*4)

'Statsd' => 'DataDog\Statsd\Facades\Illuminate',

Standalone

If you are using another framework or writing a standalone project you can just call:, _(*5)

use DataDog\Statsd\Facades\Agnostic as Statsd;

Usage

Increment

To increment things:, _(*6)

``` php Statsd::increment('your.data.point'); Statsd::increment('your.data.point', .5); Statsd::increment('your.data.point', 1, array('tagname' => 'value'));, <sub>(*7)</sub>

### Decrement

To decrement things:

``` php
Statsd::decrement('your.data.point');

Timing

To time things:, <sub>(*8)</sub>

``` php $start_time = microtime(true); run_function(); Statsd::timing('your.data.point', microtime(true) - $start_time);, <sub>(*9)</sub>

Statsd::timing('your.data.point', microtime(true) - $start_time, 1, array('tagname' => 'value'));, <sub>(*10)</sub>

### Submitting events

Requires PHP >= 5.3.0 and the [PECL http](http://www.php.net/manual/en/http.install.php) extension

To submit events, you'll need to first configure the library with your
Datadog credentials, since the event function submits directly to Datadog
instead of sending to a local dogstatsd instance.

``` php
$apiKey = 'myApiKey';
$appKey = 'myAppKey';

Statsd::configure($apiKey, $appKey);
Statsd::event('A thing broke!', array(
    'alert_type'      => 'error',
    'aggregation_key' => 'test_aggr'
));
Statsd::event('Now it is fixed.', array(
    'alert_type'      => 'success',
    'aggregation_key' => 'test_aggr'
));

This is what you'd see your Datadog event stream:, <sub>(*11)</sub>

, <sub>(*12)</sub>

You can find your api and app keys in the API tab., <sub>(*13)</sub>

For more documentation on the optional values of events, see http://docs.datadoghq.com/api/#events/., <sub>(*14)</sub>

Note that while sending metrics with this library is fast since it's sending locally over UDP, sending events will be slow because it's sending data directly to Datadog over HTTP. We'd like to improve this in the near future., <sub>(*15)</sub>

Original Author

Alex Corley - anthroprose@gmail.com, <sub>(*16)</sub>