stevenscg/statsd-php

Sends statistics to a statsd daemon over UDP

PHP Class for StatsD

Send statistics to the statsd daemon over UDP., _(*1)

This class generally follows the official php-example from Etsy, but moves the configuration options into the main class with reasonable defaults. This should make incorporation into framework-based applications more straightforward., _(*2)

Installation

Installation is via composer:, _(*3)

composer require stevenscg/statsd-php

Configuration

The library can be configured by calling StatsD::config($params)., _(*4)

$params is an array that supports the following keys:, _(*5)

enabled - boolean - Set to false to disable UDP transmission (default: true), _(*6)

prefix - string - Apply a global namespace to all metrics from this application, _(*7)

host - string - Hostname or IP of your carbon/graphite server, _(*8)

port - integer - StatsD port of your carbon/graphite server, _(*9)

The library can also be configured via environment variables:, _(*10)

STATSD_ENABLED - A boolean-like string (i.e. true, false, 1, 0), _(*11)

STATSD_PREFIX - string, _(*12)

STATSD_ADDR - string - Example: 127.0.0.1:8125, _(*13)

StatsD Data Types and Class Methods

• Counting - increment and decrement, _(*14)

• Timing - timing, _(*15)

• Sampling - supported via "sampleRate" parameter on increment and decrement, _(*16)

• Gauges - gauge, _(*17)

• Sets - set, _(*18)

Usage

All methods are declared as static as they were in the upstream project., _(*19)

Incrementing a counter is as simple as:, _(*20)

StatsD::increment("api.requests");

Example: Tracking logins and failures, _(*21)

function login() {
  ...
  if (!$this->Auth->login()) {
    StatsD::increment("logins.failed");
    return;
  }
  StatsD::increment("logins.ok");
  ...
}

License

MIT, _(*22)