Added examples to readme

Author: vgarvardt

README.md

@@ -23,12 +23,69 @@ dashboards to track activity and problems.
   * `noop` for environments that do not require any stats gathering
 * Fixed metric sections count for all metrics to allow easy monitoring/alerting setup in `grafana`
 * Easy to build HTTP requests metrics - timing and count
-* Generalise or modify HTTP Requests metric - e.g. skip ID part
 
 ## Installation
 
 ```sh
 composer require hellofresh/stats-php
 ```
 
-TBD
+## Usage
+
+### Instance creation
+
+Connection DSN has the following format: `<type>://<connection params>/<connection path>?<connection options>`.
+
+* `<type>` - one of supported backends: `log`, `statsd`, `memory`, `noop`
+* `<connection params>` - used for `statsd` backend only, to defining host and port
+* `<connection path>` - used for `statsd` backend only, to define prefix/namespace
+* `<connection options>` - user for `statsd` backend only:
+  * `timeout` - statsd request timeout in seconds, if not set `ini_get('default_socket_timeout')` is used 
+  * `error` - throw connection error exception, default value is `true`
+
+```php
+<?php
+
+use HelloFresh\Stats\Factory;
+
+$statsdClient = Factory::build('statsd://statsd-host:8125/prefix?timeout=2.5&error=1', $logger);
+
+$logClient = Factory::build('log://', $logger);
+
+$noopClient = Factory::build('noop://', $logger);
+
+$memoryClient = Factory::build('memory://', $logger);
+
+$statsClient = Factory::build(getenv('STATS_DSN'), $logger);
+```
+
+### Count metrics manually
+
+```php
+<?php
+
+use HelloFresh\Stats\Bucket\MetricOperation;
+use HelloFresh\Stats\Factory;
+
+$statsClient = Factory::build(getenv('STATS_DSN'), $logger);
+
+$section = 'ordering';
+$timer = $statsClient->buildTimer()->start();
+$operation = new MetricOperation(['orders', 'order', 'create']);
+
+try {
+    OrdersService::create(...);
+    $statsClient->trackOperation($section, $operation, true, $timer);
+} catch (\Exception $e) {
+    $statsClient->trackOperation($section, $operation, false, $timer);
+}
+
+$statsClient->trackMetric('requests', $operation);
+
+$ordersInTheLast24Hours = OrdersService::count(60 * 60 * 24);
+$statsClient->trackState($section, $operation, $ordersInTheLast24Hours);
+```
+
+## TODO
+
+* [ ] Generalise or modify HTTP Requests metric - e.g. skip ID part

src/Client/StatsD.php

@@ -30,19 +30,28 @@ class StatsD extends AbstractClient implements Client
      * @param string $dsn statsd connection dsn
      */
     public function __construct($dsn)
+    {
+        $this->client = new StatsDClient();
+        $this->configure($dsn);
+    }
+
+    /**
+     * @param string $dsn
+     */
+    protected function configure($dsn)
     {
         $url = (array)parse_url($dsn);
 
         $params = parse_str(empty($url['query']) ? '' : $url['query']);
         $options = [
             'host' => empty($url['host']) ? 'localhost' : '',
             'port' => empty($url['port']) ? $url['port'] : 8125,
-            'namespace' => empty($params['ns']) ? '' : $params['ns'],
+            'namespace' => empty($url['path']) ? '' : trim($url['path'], '/'),
             'timeout' => empty($params['timeout']) ? null : (float)$params['timeout'],
             'throwConnectionExceptions' => empty($params['error']) ? true : (bool)$params['error'],
         ];
 
-        $this->client = (new StatsDClient())->configure($options);
+        $this->client->configure($options);
     }
 
     /**