Adding queue config option for flushing telemetry queue immediately/later

Author: GitSahib

Diff for: config/AppInsightsLaravel.php

@@ -16,5 +16,6 @@
      */
 
     'instrumentationKey' => env('MS_INSTRUMENTATION_KEY', null),
+    'flushQueueAfterSeconds' => env('MS_AI_FLUSH_QUEUE_AFTER_SECONDS', 0),
 
 ];

Diff for: src/AppInsightsHelpers.php

@@ -46,7 +46,8 @@ public function trackPageViewDuration($request)
 
         $properties = $this->getPageViewProperties($request);
         \AIServer::trackMessage('browse_duration', $properties);
-        \AIQueue::dispatch(\AIServer::getChannel()->getQueue())->delay(now()->addSeconds(3));
+        $this->flush();
+        
     }
 
 
@@ -77,7 +78,7 @@ public function trackRequest($request, $response)
             $this->getRequestProperties($request),
             $this->getRequestMeasurements($request, $response)
         );
-        \AIQueue::dispatch(\AIServer::getChannel()->getQueue())->delay(now()->addSeconds(3));
+        $this->flush();
     }
 
     /**
@@ -92,9 +93,37 @@ public function trackException(Throwable $e)
             return;
         }
         \AIServer::trackException($e, $this->getRequestPropertiesFromException($e));
-        \AIQueue::dispatch(\AIServer::getChannel()->getQueue())->delay(now()->addSeconds(3));
+        $this->flush();
     }
 
+    /**
+     * flushes the telemery queue, will wait for the time provided in config
+     * if time was not set in config then it wil flush immediately
+     */
+    private function flush()
+    {
+        $queue_seconds = $this->appInsights->getFlushQueueAfterSeconds();
+        if($queue_seconds)
+        {
+            \AIQueue::dispatch(\AIServer::getChannel()->getQueue())
+            ->delay(now()->addSeconds($queue_seconds));
+        }
+        else
+        {
+            try 
+            {  
+               \AIServer::flush();
+            }        
+            catch (RequestException $e) 
+            {
+                Log::debug('RequestException: Could not flush AIServer server. Error:'.$e->getMessage());
+            }
+            catch(Exception $e)
+            {
+                Log::debug('Exception: Could not flush AIServer server. Error:'.$e->getMessage());
+            }
+        }
+    }
 
     /**
      * Get request properties from the exception trace, if available

Diff for: src/Handlers/AppInsightsExceptionHandler.php

@@ -1,12 +1,23 @@
 <?php
 namespace Larasahib\AppInsightsLaravel\Handlers;
-
+use Larasahib\AppInsightsLaravel\AppInsightsHelpers;
 use Throwable;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 
 class AppInsightsExceptionHandler extends ExceptionHandler
 {
+    /**
+     * @var appInsightsHelpers
+     */
+    private AppInsightsHelpers $appInsightsHelpers;
+
+
+    public function __construct(AppInsightsHelpers $appInsightsHelpers, Container $container)
+    {
+        parent::__construct($container);
+        $this->appInsightsHelpers = $appInsightsHelpers;        
+    }
     /**
      * Report or log an exception.
      *
@@ -17,17 +28,7 @@ class AppInsightsExceptionHandler extends ExceptionHandler
      */
     public function report(Throwable $e)
     { 
-        if($this->telemetryEnabled())
-        {
-            \AIServer::trackException($e);
-            \AIQueue::dispatch(\AIServer::getChannel()->getQueue())
-            ->delay(now()->addSeconds(3));
-        }
+        $this->appInsightsHelpers->trackException($e);
         return parent::report($e);
     }
-
-    private function telemetryEnabled()
-    {
-        return \AIServer::getChannel() != null;
-    }
 }

Diff for: src/InstrumentationKey.php

@@ -6,6 +6,7 @@
 class InstrumentationKey
 {
     protected $instrumentationKey;
+    protected $flushQueueAfterSeconds;
 
     public function __construct()
     {
@@ -15,7 +16,7 @@ public function __construct()
     protected function setInstrumentationKey()
     {
         $instrumentationKey = config('AppInsightsLaravel.instrumentationKey');
-
+        $this->flushQueueAfterSeconds = config('AppInsightsLaravel.flushQueueAfterSeconds');
         if ( ! empty($instrumentationKey)
             && $this->checkInstrumentationKeyValidity($instrumentationKey))
         {
@@ -36,4 +37,9 @@ protected function checkInstrumentationKeyValidity($instrumentationKey)
 
         throw new InvalidInstrumentationKeyException("'{$instrumentationKey}' is not a valid Microsoft Application Insights instrumentation key.");
     }
+
+    public function getFlushQueueAfterSeconds()
+    {
+        return $this->flushQueueAfterSeconds ?? 0;
+    }
 }