darkflib/php-statsd

Statsd library for PHP

PHP StatsD Client

This is an extremely simple PHP statsd client and CI spark., _(*1)

Installation

Use composer..., _(*2)

Usage

Counting

To count things:, _(*3)

``` php $stats = new PhpStatsD\StatsD(); $stats->counting('numpoints', 123);, <sub>(*4)</sub>

### Guages

``` php
$stats = new PhpStatsD\StatsD();
$stats->gauge('coffee_left', 3);

Timing

Record timings:, <sub>(*5)</sub>

``` php $stats = new PhpStatsD\StatsD(); $stats->timing('timething', 123);, <sub>(*6)</sub>

### Time Block

And a convenience mechanism for timing:

``` php
$stats = new PhpStatsD\StatsD();
$stats->time_this('timething', function() {
    sleep(1);
});

Configuration

Host and Port

``` php $stats = new PhpStatsD\StatsD('localhost', 7000); // default localhost:8125, <sub>(*7)</sub>

### Sample Rate

Any of the methods descriped in the usage section can take an optional third argument `$rate`, which is the sample rate:

``` php
$stats = new StatsD();
$stats->counting('numpoints', 123, 0.1);

As a CodeIgniter library

php $this->load->library('statsd'); $this->statsd->counting('numpoints', 123);, <sub>(*8)</sub>

Author

John Crepezzi - john.crepezzi@gmail.com, <sub>(*9)</sub>

License

(The MIT License), <sub>(*10)</sub>

Copyright © 2012 John Crepezzi, <sub>(*11)</sub>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, <sub>(*12)</sub>

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., <sub>(*13)</sub>

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. MIT License. See attached LICENSE, <sub>(*14)</sub>