add backwards compatibily for non dataDog statsd server

rename to DogStatsD
graze · Nov 4, 2015 · a14bde0 · a14bde0
1 parent 285c1ea
commit a14bde0
Show file tree

Hide file tree

Showing 20 changed files with 143 additions and 70 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,4 +12,8 @@ matrix:
 
 before_script:
   - travis_retry composer self-update
-  - travis_retry composer update --no-interaction --prefer-source
+  - travis_retry composer install --no-interaction --prefer-source
+
+script:
+  - make test
+  - make lint
diff --git a/Makefile b/Makefile
@@ -1,8 +1,14 @@
-.PHONY: test test-coverage test-unit test-unit-coverage install
+.PHONY: test lint lint-auto-fix test-coverage test-unit test-unit-coverage install
 
 test:
 	@./vendor/bin/phpunit
 
+lint:
+	@./vendor/bin/phpcs -p --standard=PSR2 --warning-severity=0 src/ tests/
+
+lint-fix:
+	@./vendor/bin/phpcbf -p --standard=PSR2 src/ tests/
+
 test-coverage:
 	@./vendor/bin/phpunit --coverage-text --coverage-html ./tests/report
 

diff --git a/README.md b/README.md
@@ -3,11 +3,10 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/graze/statsd-dd.svg?style=flat-square)](https://packagist.org/packages/graze/statsd-dd)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
 [![Build Status](https://img.shields.io/travis/graze/statsd-dd/master.svg?style=flat-square)](https://travis-ci.org/graze/statsd-dd)
-[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/graze/statsd-dd.svg?style=flat-square)](https://scrutinizer-ci.com/g/graze/statsd-dd/code-structure)
-[![Quality Score](https://img.shields.io/scrutinizer/g/graze/statsd-dd.svg?style=flat-square)](https://scrutinizer-ci.com/g/graze/statsd-dd)
 [![Total Downloads](https://img.shields.io/packagist/dt/graze/statsd-dd.svg?style=flat-square)](https://packagist.org/packages/graze/statsd-dd)
 
-Client to talk to [DataDogs StatsD Agent](http://docs.datadoghq.com/guides/dogstatsd)
+Client to talk to [DataDogs StatsD Agent](http://docs.datadoghq.com/guides/dogstatsd) Forked from:
+[League/StatsD](https://github.com/thephpleague/statsd)
 
 ## Install
 
@@ -22,7 +21,7 @@ $ composer require graze/statsd-dd
 ### Configuring
 
 ```php
-$statsd = new Graze\DDStatsD\Client();
+$statsd = new Graze\DogStatsD\Client();
 $statsd->configure(array(
     'host' => '127.0.0.1',
     'port' => 8125,
@@ -33,8 +32,8 @@ $statsd->configure(array(
 OR
 
 ```php
-$statsd1 = DDStatsD\Client::instance('server1')->configure(array(...));
-$statsd2 = DDStatsD\Client::instance('server2')->configure(array(...));
+$statsd1 = DogStatsD\Client::instance('server1')->configure(array(...));
+$statsd2 = DogStatsD\Client::instance('server2')->configure(array(...));
 ```
 
 The StatsD client waits for `ini_get('default_socket_timeout')` seconds when opening the socket by default. To reduce
@@ -49,7 +48,16 @@ to disable these exceptions and log a PHP warning instead if you wish. To do so,
 
 If omitted, this option defaults to `true`.
 
-### Counters
+#### Core StatsD implementation
+
+To use this with a core statsd implementation include the following in your configuration:
+```
+'dataDog' => false
+```
+
+### Methods
+
+#### Counters
 
 ```php
 $statsd->increment('web.pageview');
@@ -61,43 +69,43 @@ $statsd->increment(array(
 $statsd->increment('web.clicks', 1, 0.5);
 ```
 
-### Gauges
+#### Gauges
 
 ```php
 $statsd->gauge('api.logged_in_users', 123456);
 ```
 
-
-### Sets
+#### Sets
 
 ```php
 $userID = 23;
 $statsd->set('api.unique_logins', $userID);
 ```
 
-### Timers
+#### Timers
 
 ```php
 $statsd->timing('api.response_time', 256);
 ```
 
-## Timing Blocks
+#### Timing Blocks
 
 ```php
 $statsd->time('api.dbcall', function () {
     // this code execution will be timed and recorded in ms
 });
 ```
 
-## Tags
+#### Tags
 
 ```php
 $statsd->increment('web.pageview', 1, ['page' => 'some/page']);
 $statsd->guage('api.logged_in_users', 123456, ['environement' => 'live']);
-$statsd->set('api.unique_logins', $userID, ['
+$statsd->set('api.unique_logins', $userID, ['tag']);
+$statsd->timing('api.response_time', 245, ['end-point' => 'page', 'env' => 'test']);
 ```
 
-## Events
+#### Events
 
 ```php
 $statsd->event(
@@ -113,7 +121,7 @@ $statsd->event(
 );
 ```
 
-## Service Check
+#### Service Check
 
 ```php
 $statsd->serviceCheck(
@@ -151,7 +159,7 @@ If you discover any security related issues, please email harry.bragg@graze.com
 ### Forked from [thephpleague/statsd](https://github.com/thephpleague/statsd):
 
 - [Marc Qualie](https://github.com/marcqualie)
-- [League\statsd Contributors](https://github.com/thephpleague/statsd/contributors)
+- [League/StatsD Contributors](https://github.com/thephpleague/statsd/contributors)
 
 ## License
 

diff --git a/composer.json b/composer.json
@@ -5,7 +5,8 @@
         "graze",
         "statsd-dd",
         "statsd",
-        "datadog"
+        "datadog",
+        "dogstatsd"
     ],
     "homepage": "https://github.com/graze/statsd-dd",
     "license": "MIT",
@@ -26,17 +27,18 @@
         "php": ">=5.5.0"
     },
     "require-dev": {
-        "phpunit/phpunit" : "4.*"
+        "phpunit/phpunit" : "4.*",
+        "squizlabs/php_codesniffer": "^2.3"
     },
     "autoload": {
         "psr-4": {
-            "Graze\\DDStatsD\\": "src"
+            "Graze\\DogStatsD\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Graze\\DDStatsD\\Test\\": "tests/src",
-            "Graze\\DDStatsD\\Test\\Unit\\": "tests/unit"
+            "Graze\\DogStatsD\\Test\\": "tests/src",
+            "Graze\\DogStatsD\\Test\\Unit\\": "tests/unit"
         }
     }
 }
diff --git a/src/Client.php b/src/Client.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Graze\DDStatsD;
+namespace Graze\DogStatsD;
 
-use Graze\DDStatsD\Exception\ConfigurationException;
-use Graze\DDStatsD\Exception\ConnectionException;
+use Graze\DogStatsD\Exception\ConfigurationException;
+use Graze\DogStatsD\Exception\ConnectionException;
 
 /**
  * StatsD Client Class - Modified to support DataDogs statsd server
@@ -116,6 +116,13 @@ class Client
         'message' => 'm',
     ];
 
+    /**
+     * Is the server type DataDog implementation
+     *
+     * @var bool
+     */
+    protected $dataDog = true;
+
     /**
      * Singleton Reference
      *
@@ -188,6 +195,10 @@ public function configure(array $options = array())
             $this->throwConnectionExceptions = $options['throwConnectionExceptions'];
         }
 
+        if ((isset($options['dataDog'])) && (!$options['dataDog'])) {
+            $this->dataDog = false;
+        }
+
         return $this;
     }
 
@@ -371,6 +382,10 @@ public function set($metric, $value, array $tags = [])
      */
     public function event($title, $text, array $metadata = [], array $tags = [])
     {
+        if (!$this->dataDog) {
+            return $this;
+        }
+
         $text = str_replace(["\r", "\n"], ['', "\\n"], $text);
         $metric = sprintf('_e{%d,%d}', strlen($title), strlen($text));
         $prefix = $this->namespace ? $this->namespace . '.' : '';
@@ -406,6 +421,10 @@ public function event($title, $text, array $metadata = [], array $tags = [])
      */
     public function serviceCheck($name, $status, array $metadata = [], array $tags = [])
     {
+        if (!$this->dataDog) {
+            return $this;
+        }
+
         $prefix = $this->namespace ? $this->namespace . '.' : '';
         $value = sprintf('_sc|%s|%d', $prefix . $name, $status);
 
@@ -433,7 +452,7 @@ public function serviceCheck($name, $status, array $metadata = [], array $tags =
      */
     private function formatTags(array $tags = [])
     {
-        if (count($tags) === 0) {
+        if (!$this->dataDog || count($tags) === 0) {
             return '';
         }
 

diff --git a/src/Exception/ConfigurationException.php b/src/Exception/ConfigurationException.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Graze\DDStatsD\Exception;
+namespace Graze\DogStatsD\Exception;
 
 use Exception;
-use Graze\DDStatsD\Client;
+use Graze\DogStatsD\Client;
 
 /**
  * Configuration Exception Class

diff --git a/src/Exception/ConnectionException.php b/src/Exception/ConnectionException.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Graze\DDStatsD\Exception;
+namespace Graze\DogStatsD\Exception;
 
 use Exception;
-use Graze\DDStatsD\Client;
+use Graze\DogStatsD\Client;
 
 /**
  * Connection Exception Class

diff --git a/tests/src/TestCase.php b/tests/src/TestCase.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace Graze\DDStatsD\Test;
+namespace Graze\DogStatsD\Test;
 
-use Graze\DDStatsD\Client;
+use Graze\DogStatsD\Client;
 use PHPUnit_Framework_TestCase;
 
 class TestCase extends PHPUnit_Framework_TestCase

diff --git a/tests/unit/ClientTest.php b/tests/unit/ClientTest.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Graze\DDStatsD\Test\Unit;
+namespace Graze\DogStatsD\Test\Unit;
 
-use Graze\DDStatsD\Client;
-use Graze\DDStatsD\Test\TestCase;
+use Graze\DogStatsD\Client;
+use Graze\DogStatsD\Test\TestCase;
 
 class ClientTest extends TestCase
 {

diff --git a/tests/unit/ConfigurationTest.php b/tests/unit/ConfigurationTest.php
@@ -1,15 +1,15 @@
 <?php
 
-namespace Graze\DDStatsD\Test\Unit;
+namespace Graze\DogStatsD\Test\Unit;
 
-use Graze\DDStatsD\Test\TestCase;
+use Graze\DogStatsD\Test\TestCase;
 
 class ConfigurationTest extends TestCase
 {
     /**
      * Large ports should be out of range
      *
-     * @expectedException \Graze\DDStatsD\Exception\ConfigurationException
+     * @expectedException \Graze\DogStatsD\Exception\ConfigurationException
      */
     public function testLargePort()
     {
@@ -22,7 +22,7 @@ public function testLargePort()
     /**
      * Non-integer ports are not acceptable
      *
-     * @expectedException \Graze\DDStatsD\Exception\ConfigurationException
+     * @expectedException \Graze\DogStatsD\Exception\ConfigurationException
      */
     public function testStringPort()
     {

diff --git a/tests/unit/ConnectionTest.php b/tests/unit/ConnectionTest.php
@@ -1,15 +1,15 @@
 <?php
 
-namespace Graze\DDStatsD\Test\Unit;
+namespace Graze\DogStatsD\Test\Unit;
 
-use Graze\DDStatsD\Test\TestCase;
+use Graze\DogStatsD\Test\TestCase;
 
 class ConnectionTest extends TestCase
 {
     /**
      * Non-integer ports are not acceptable
      *
-     * @expectedException \Graze\DDStatsD\Exception\ConnectionException
+     * @expectedException \Graze\DogStatsD\Exception\ConnectionException
      */
     public function testInvalidHost()
     {

diff --git a/tests/unit/CounterTest.php b/tests/unit/CounterTest.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace Graze\DDStatsD\Test\Unit;
+namespace Graze\DogStatsD\Test\Unit;
 
-use Graze\DDStatsD\Test\TestCase;
+use Graze\DogStatsD\Test\TestCase;
 
 class CounterTest extends TestCase
 {
@@ -23,7 +23,7 @@ public function testIncrementDelta()
     public function testIncrementSample()
     {
         while ($this->client->getLastMessage() === '') {
-            $this->client->increment('test_metric', 1,  0.75);
+            $this->client->increment('test_metric', 1, 0.75);
         }
         $this->assertEquals('test_metric:1|c|@0.75', $this->client->getLastMessage());
     }

diff --git a/tests/unit/EventTest.php b/tests/unit/EventTest.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace Graze\DDStatsD\Test\Unit;
+namespace Graze\DogStatsD\Test\Unit;
 
-use Graze\DDStatsD\Client;
-use Graze\DDStatsD\Test\TestCase;
+use Graze\DogStatsD\Client;
+use Graze\DogStatsD\Test\TestCase;
 
 class EventTest extends TestCase
 {
@@ -54,4 +54,15 @@ public function testEventTextReplacesNewLines()
         $this->client->event('some_title', "LongText\rAnd\nStuff");
         $this->assertEquals("_e{10,18}:some_title|LongTextAnd\\nStuff", $this->client->getLastMessage());
     }
+
+    public function testCoreStatsDImplementation()
+    {
+        $this->client->configure(array(
+            'host' => '127.0.0.1',
+            'port' => 8125,
+            'dataDog' => false
+        ));
+        $this->client->event('some_title', 'textAndThings');
+        $this->assertEquals('', $this->client->getLastMessage());
+    }
 }