Add error governor functionality

Author: Dmitry Tarasov

src/Stackify/Log/Builder/BuilderInterface.php

@@ -2,6 +2,7 @@
 
 namespace Stackify\Log\Builder;
 
+use Stackify\Log\Entities\Api\LogMsg;
 use Stackify\Log\Entities\LogEntryInterface;
 
 interface BuilderInterface
@@ -10,7 +11,7 @@ interface BuilderInterface
     /**
      * @return string  Formatted JSON
      */
-    public function getAgentMessage(LogEntryInterface $logEntry);
+    public function getAgentMessage(LogMsg $logMsg);
 
     /**
      * @param \Stackify\Log\Entities\Api\LogMsg[] $logMsgs

src/Stackify/Log/Builder/MessageBuilder.php

@@ -32,9 +32,8 @@ public function __construct($loggerName, $appName, $environmentName = null)
         EnvironmentDetail::getInstance()->init($appName, $environmentName);
     }
 
-    public function getAgentMessage(LogEntryInterface $logEntry)
+    public function getAgentMessage(LogMsg $logMsg)
     {
-        $logMsg = $this->createLogMsg($logEntry);
         $message = new AgentMessage($this->loggerName, $this->appName, $this->environmentName, $logMsg);
         return $this->encodeJSON($message). PHP_EOL;
     }

src/Stackify/Log/Builder/NullBuilder.php

@@ -2,6 +2,7 @@
 
 namespace Stackify\Log\Builder;
 
+use Stackify\Log\Entities\Api\LogMsg;
 use Stackify\Log\Entities\LogEntryInterface;
 
 /**
@@ -12,7 +13,7 @@ class NullBuilder implements BuilderInterface
 
     public function createLogMsg(LogEntryInterface $logEntry) {}
 
-    public function getAgentMessage(LogEntryInterface $logEntry) {}
+    public function getAgentMessage(LogMsg $logMsg) {}
 
     public function getApiMessage(array $logMsgs) {}
 

src/Stackify/Log/Filters/ErrorGovernor.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Stackify\Log\Filters;
+
+use Stackify\Log\Entities\Api\LogMsg;
+use Stackify\Log\Entities\Api\ErrorItem;
+use Stackify\Log\Entities\Api\StackifyError;
+
+class ErrorGovernor
+{
+
+    const MAX_DUPLICATES = 100;
+
+    private $counter = array();
+
+    public function shouldBeSent(LogMsg $logMsg = null)
+    {
+        if (!isset($logMsg->Ex)) {
+            return true;
+        }
+        $errorItem = $this->getBaseError($logMsg->Ex);
+        $key = $this->getUniqueKey($errorItem);
+        if (!isset($this->counter[$key])) {
+            $this->counter[$key] = 0;
+        }
+        return (++$this->counter[$key] <= self::MAX_DUPLICATES);
+    }
+
+    /**
+     * @return \Stackify\Log\Entities\Api\ErrorItem
+     */
+    private function getBaseError(StackifyError $error)
+    {
+        $errorItem = $error->Error;
+        while (null !== $errorItem->InnerError) {
+            $errorItem = $errorItem->InnerError;
+        }
+        return $errorItem;
+    }
+
+    private function getUniqueKey(ErrorItem $item)
+    {
+        $key = sprintf('%s-%s-%s', $item->ErrorType, $item->ErrorTypeCode, $item->SourceMethod);
+        return md5($key);
+    }
+
+}

src/Stackify/Log/Transport/AbstractApiTransport.php

@@ -23,7 +23,10 @@ public function __construct($apiKey, array $options = array())
 
     public function addEntry(LogEntryInterface $logEntry)
     {
-        $this->queue[] = $this->messageBuilder->createLogMsg($logEntry);
+        $logMsg = $this->messageBuilder->createLogMsg($logEntry);
+        if ($this->errorGovernor->shouldBeSent($logMsg)) {
+            $this->queue[] = $logMsg;
+        }
     }
 
     public function finish()

src/Stackify/Log/Transport/AbstractTransport.php

@@ -4,6 +4,7 @@
 
 use Stackify\Log\Builder\BuilderInterface;
 use Stackify\Log\Builder\NullBuilder;
+use Stackify\Log\Filters\ErrorGovernor;
 use Stackify\Exceptions\InitializationException;
 
 abstract class AbstractTransport implements TransportInterface
@@ -13,13 +14,20 @@ abstract class AbstractTransport implements TransportInterface
      * @var \Stackify\Log\Builder\BuilderInterface
      */
     protected $messageBuilder;
+
+    /**
+     * @var \Stackify\Log\Filters\ErrorGovernor
+     */
+    protected $errorGovernor;
+
     protected $debug = false;
     private $debugLogPath;
 
     public function __construct()
     {
         $ds = DIRECTORY_SEPARATOR;
         $this->debugLogPath = realpath(dirname(__FILE__) . "$ds..$ds..") . $ds . 'debug/log.log';
+        $this->errorGovernor = new ErrorGovernor();
         // add empty implementation to avoid method calls on non-object
         $this->setMessageBuilder(new NullBuilder());
     }

src/Stackify/Log/Transport/AgentTransport.php

@@ -32,8 +32,11 @@ public function __construct(array $options = array())
 
     public function addEntry(LogEntryInterface $logEntry)
     {
-        $data = $this->messageBuilder->getAgentMessage($logEntry);
-        $this->send($data);
+        $logMsg = $this->messageBuilder->createLogMsg($logEntry);
+        if ($this->errorGovernor->shouldBeSent($logMsg)) {
+            $data = $this->messageBuilder->getAgentMessage($logMsg);
+            $this->send($data);
+        }
     }
 
     public function finish()