Merge pull request #34 from utopia-php/feat-add-sampler

Add sample function to logger

Author: christyjacob4

src/Logger/Logger.php

@@ -15,6 +15,11 @@ class Logger
         'logOwl',
     ];
 
+    /**
+     * @var float|null
+     */
+    protected $samplePercent = null;
+
     /**
      * @var Adapter
      */
@@ -51,6 +56,12 @@ public function addLog(Log $log): int
             throw new Exception('Log is not ready to be pushed.');
         }
 
+        if (! is_null($this->samplePercent)) {
+            if (rand(0, 100) <= $this->samplePercent) {
+                return 0;
+            }
+        }
+
         if ($this->adapter->validate($log)) {
             // Push log
             return $this->adapter->push($log);
@@ -85,4 +96,27 @@ public static function hasProvider(string $providerName): bool
 
         return false;
     }
+
+    /**
+     * Return only a sample of the logs from this logger
+     *
+     * @param  float  $sample Total percentage of issues to use with 100% being 1
+     * @return self
+     */
+    public function setSample(float $sample): self
+    {
+        $this->samplePercent = $sample * 100;
+
+        return $this;
+    }
+
+    /**
+     * Get the current sample value as a percentage
+     *
+     * @return float|null
+     */
+    public function getSample(): float|null
+    {
+        return $this->samplePercent;
+    }
 }

tests/e2e/AdapterBase.php

@@ -58,4 +58,32 @@ public function testAdapter(): void
         $response = $logger->addLog($this->log);
         $this->assertEquals($this->expected, $response);
     }
+
+    /**
+     * @throws \Throwable
+     */
+    public function testSampler(): void
+    {
+        if (empty($this->log) || empty($this->adapter)) {
+            throw new \Exception('Log or adapter not set');
+        }
+
+        $logger = new Logger($this->adapter);
+        $logger->setSample(0.1);
+
+        $results = [];
+        $zeroCount = 0;
+
+        for ($x = 0; $x <= 100; $x++) {
+            $result = $logger->addLog($this->log);
+            $results[] = $result;
+            if ($result === 0) {
+                $zeroCount++;
+            }
+        }
+
+        $zeroPercentage = ($zeroCount / count($results)) * 100;
+
+        $this->assertLessThan(20, $zeroPercentage);
+    }
 }