Merge pull request #25 from aivis/feature/ignored_logs

add ignored_logs config property

Author: aivis

src/Understand/UnderstandLaravel5/UnderstandLaravel5ServiceProvider.php

@@ -292,6 +292,11 @@ protected function listenQueryEvents()
      */
     protected function handleEvent($level, $message, $context)
     {
+        if ($this->shouldIgnoreEvent($level, $message, $context))
+        {
+            return;
+        }
+
         // `\Log::info`, `\Log::debug` and NOT `\Exception` or `\Throwable`
         if (in_array($level, ['info', 'debug']) && ! ($message instanceof Exception || $message instanceof Throwable))
         {
@@ -311,6 +316,24 @@ protected function handleEvent($level, $message, $context)
         }
     }
 
+    /**
+     * @param $level
+     * @param $message
+     * @param $context
+     * @return bool
+     */
+    protected function shouldIgnoreEvent($level, $message, $context)
+    {
+        $ignoredEventTypes = (array)$this->app['config']->get('understand-laravel.ignored_logs');
+
+        if ( ! $ignoredEventTypes)
+        {
+            return false;
+        }
+
+        return in_array($level, $ignoredEventTypes, true);
+    }
+
     /**
      * Get the services provided by the provider.
      *

src/config/understand-laravel.php

@@ -33,5 +33,21 @@
     /**
      * SSL CA Bundle location
      */
-    'ssl_ca_bundle' => base_path('vendor/understand/understand-laravel5/src/ca_bundle.crt')
+    'ssl_ca_bundle' => base_path('vendor/understand/understand-laravel5/src/ca_bundle.crt'),
+
+    /**
+     * The log types that should not be sent to Understand.io.
+     *
+     * By default, send everything.
+     */
+    'ignored_logs' => [
+        //'debug',
+        //'info',
+        //'notice',
+        //'warning',
+        //'error',
+        //'critical',
+        //'alert',
+        //'emergency',
+    ],
 ];

tests/EventListenerTest.php

@@ -48,6 +48,36 @@ public function testEventListener()
         $this->assertSame($called, 1);
         $this->assertTrue($messageSame);
     }
+
+    /**
+     * Test event listener
+     *
+     * @return void
+     */
+    public function testIgnoredLogsConfig()
+    {
+        $called = 0;
+
+        $callback = function($data) use(&$called)
+        {
+            $called++;
+        };
+
+        $this->app['config']->set('understand-laravel.ignored_logs', ['debug', 'notice']);
+
+        $handler = new CallbackHandler($callback);
+        $this->app['understand.logger'] = new Logger($this->app['understand.fieldProvider'], $handler, false);
+
+        // debug and notice should be ignored
+        $this->app['Psr\Log\LoggerInterface']->debug('test');
+        $this->app['Psr\Log\LoggerInterface']->notice('test');
+
+        // error and alert should reach the logger
+        $this->app['Psr\Log\LoggerInterface']->error('test');
+        $this->app['Psr\Log\LoggerInterface']->alert('test');
+
+        $this->assertSame($called, 2);
+    }
 
     /**
      * Test error handler logging