heapstersoft/stats-writer

Php Stats Writer

Stats

Intro

Stats is a small php project to help using stats from your current project. It supports any backend for which you want to write an adapter and it comes with one for statsd., _(*1)

Installing

No actual installation is needed just add this to your composer.json require section:, _(*2)

    "heapstersoft/stats-writer": "1.0.x-dev"

Usage

First of all you need to include your composer autoload as with any project using composer:, _(*3)

    require 'vendor/autoload.php';

ideally you would do this in one central place and only once., _(*4)

Then to send a stat to the backend (see configuration section) you need to create a stats object passing the config file as a first paramenter and the just use either increment or decrement:, _(*5)

    $statWriter = new \Heapstersoft\Stats\Writer('config/stats.yml');

    $statWriter->increment('key1');

For more information I encourage you to view the source code., _(*6)

Congfiguration

Stats uses a simple YAML file as configuration with a mandatory "Adapter" key., _(*7)

Under adapter you just neet the adapter class. The rest of the parameters ara adapter specific., _(*8)

For an example configuration see the StatsD adapter section., _(*9)

Adapters

StatsD

Example configuration file for StatsD:, _(*10)

    Adapter:
      class: \Heapstersoft\Stats\Adapter\StatsD
      host: "127.0.0.1"
      port: 8125
      key: "#host#.test.#key#"

All parameter should be self explainatory except for the "key" parameter., _(*11)

Key allows you to customize the key string sent to the statsd backend. It suports any string with some special placeholders., _(*12)

Right now these placeholders are: #host# that is replaced by the $_SERVER['HTTP_HOST'] variable and the #key# that is replaced for the value you pass to increment or decremant., _(*13)

If no #key# is spcecified, it is appended., _(*14)