ExceptionCatchingDataDogClient (#14)

* safe dog

* add override

* Update ExceptionCatchingDatadogClient.php

* clean up

* readme

---------

Co-authored-by: Luke Kuzmish <[email protected]>

Author: cosmastech

README.md

@@ -47,6 +47,11 @@ For a local development setup, you could just write the stats to a log. This wri
 
 See [examples/log_datadog.php](examples/log_datadog.php) for how you might implement this.
 
+### ExceptionCatchingDatadogClient
+This client will allow handling exceptions thrown when attempting to write data to DataDog.
+
+See [examples/safe_datadog.php](examples/safe_datadog.php) for how to use this client.
+
 ### LeagueStatsDClientAdapter
 You can also write to an arbitrary statsd server by leveraging [PHP League's statsd package](https://github.com/thephpleague/statsd).
 

examples/safe_datadog.php

@@ -0,0 +1,22 @@
+<?php
+
+require_once __DIR__ . "/../vendor/autoload.php";
+
+// See instantiation parameters: https://docs.datadoghq.com/developers/dogstatsd/?code-lang=php&tab=hostagent#client-instantiation-parameters
+
+// You will need Monolog installed to run this example.
+
+$logger = new \Monolog\Logger('safe_datadog');
+$logger->pushHandler(new \Monolog\Handler\StreamHandler(__DIR__ . '/log_datadog.txt', \Monolog\Level::Debug));
+
+$datadog = new \Cosmastech\StatsDClientAdapter\Clients\Datadog\ExceptionCatchingDatadogClient(
+    [],
+    static fn (\Throwable $t) => $logger->error('Exception: ' . $t->getMessage())
+);
+
+$adapter = new \Cosmastech\StatsDClientAdapter\Adapters\Datadog\DatadogStatsDClientAdapter($datadog);
+
+$adapter->increment("logins", 1, ["type" => "successful"], 1); // assume that this fails
+
+// You should see a file named log_datadog.txt in this directory which will have stats
+// ex: [2024-07-08T23:59:18.880180+00:00] safe_datadog.ERROR: Exception: ErrorException: socket_sendto(): Unable to write to socket [111]: Connection refused in /var/www/vendor/datadog/php-datadogstatsd/src/DogStatsd.php:502

src/Adapters/Concerns/ConvertsStatTrait.php

@@ -15,7 +15,7 @@ protected function convertStat(mixed $value): string|array
     {
         if (is_array($value)) {
             $convertedStats = [];
-            foreach($value as $element) {
+            foreach ($value as $element) {
                 $convertedStats[] = $this->convertValueToString($element);
             }
 

src/Clients/Datadog/ExceptionCatchingDatadogClient.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Cosmastech\StatsDClientAdapter\Clients\Datadog;
+
+use Closure;
+use DataDog\DogStatsd;
+use Throwable;
+
+class ExceptionCatchingDatadogClient extends DogStatsd
+{
+    /**
+     * The callback to execute when there is an exception flushing stats to DataDog.
+     *
+     * @var Closure(Throwable, mixed): void
+     */
+    protected Closure $onExceptionCallback;
+
+    /**
+     * @{inheritDoc}
+     *
+     * @param  (Closure(\Throwable, mixed): void)  $onExceptionCallback The callback to execute when there is an exception flushing stats to DataDog
+     */
+    public function __construct(
+        array $config,
+        Closure $onExceptionCallback,
+    ) {
+        parent::__construct($config);
+
+        $this->onExceptionCallback = $onExceptionCallback;
+    }
+
+    /**
+     * @param  mixed $message
+     * @return void
+     */
+    #[\Override]
+    public function report($message)
+    {
+        try {
+            parent::report($message);
+        } catch (Throwable $exception) {
+            call_user_func($this->onExceptionCallback, $exception, $message);
+        }
+    }
+}

tests/Doubles/DogStatsDSpy.php

@@ -34,70 +34,78 @@ public function __construct()
 
     /**
      * @inheritDoc
+     * @param mixed $cardinality
      * @phpstan-ignore missingType.iterableValue
      */
-    public function timing($stat, $time, $sampleRate = 1.0, $tags = null)
+    public function timing($stat, $time, $sampleRate = 1.0, $tags = null, $cardinality = null)
     {
-        $this->timings[] = compact('stat', 'time', 'sampleRate', 'tags');
+        $this->timings[] = compact('stat', 'time', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritDoc
+     * @param mixed $cardinality
      * @phpstan-ignore missingType.iterableValue
      */
-    public function gauge($stat, $value, $sampleRate = 1.0, $tags = null)
+    public function gauge($stat, $value, $sampleRate = 1.0, $tags = null, $cardinality = null)
     {
-        $this->gauges[] = compact('stat', 'value', 'sampleRate', 'tags');
+        $this->gauges[] = compact('stat', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritDoc
+     * @param mixed $cardinality
      * @phpstan-ignore missingType.iterableValue
      */
-    public function histogram($stat, $value, $sampleRate = 1.0, $tags = null)
+    public function histogram($stat, $value, $sampleRate = 1.0, $tags = null, $cardinality = null)
     {
-        $this->histograms[] = compact('stat', 'value', 'sampleRate', 'tags');
+        $this->histograms[] = compact('stat', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritDoc
+     * @param mixed $cardinality
      * @phpstan-ignore missingType.iterableValue
      */
-    public function distribution($stat, $value, $sampleRate = 1.0, $tags = null)
+    public function distribution($stat, $value, $sampleRate = 1.0, $tags = null, $cardinality = null)
     {
-        $this->distributions[] = compact('stat', 'value', 'sampleRate', 'tags');
+        $this->distributions[] = compact('stat', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritdoc
+     * @param mixed $cardinality
      * @phpstan-ignore missingType.iterableValue
      */
-    public function set($stat, $value, $sampleRate = 1.0, $tags = null)
+    public function set($stat, $value, $sampleRate = 1.0, $tags = null, $cardinality = null)
     {
-        $this->sets[] = compact('stat', 'value', 'sampleRate', 'tags');
+        $this->sets[] = compact('stat', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritDoc
-     * @param  string|array<int, mixed> $stats
-     * @param  array<int, mixed>|string $tags
+     * @param mixed $cardinality
+     * @param string|array<int, mixed> $stats
+     * @param array<int, mixed>|string $tags
      */
     public function increment(
         $stats,
         $sampleRate = 1.0,
         $tags = null,
-        $value = 1
+        $value = 1,
+        $cardinality = null
     ) {
-        $this->increments[] = compact('stats', 'value', 'sampleRate', 'tags');
+        $this->increments[] = compact('stats', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 
     /**
      * @inheritdoc
-     * @param  string|array<int, mixed>  $stats
-     * @param  array<int, mixed>|string  $tags
+     * @param string|array<int, mixed> $stats
+     * @param array<int, mixed>|string $tags
+     * @param mixed $cardinality
      */
-    public function decrement($stats, $sampleRate = 1.0, $tags = null, $value = -1)
+    public function decrement($stats, $sampleRate = 1.0, $tags = null, $value = -1, $cardinality = null)
     {
-        $this->decrements[] = compact('stats', 'value', 'sampleRate', 'tags');
+        $this->decrements[] = compact('stats', 'value', 'sampleRate', 'tags', 'cardinality');
     }
 }