Merge pull request #7 from silverleague/feature/configure-minimum-log-level

API Add configurable minimum log capture level - default 300 (warning)

Author: robbieaverill

.scrutinizer.yml

@@ -1,6 +1,17 @@
+inherit: true
+
 filter:
   paths: [src/*, tests/*]
 
 checks:
-  php: true
+  php:
+    code_rating: true
+    duplication: true
 
+build:
+  dependencies:
+    override:
+      - true
+  tests:
+    override:
+      - phpcs-run

_config/config.yml

@@ -18,3 +18,5 @@ LogViewer:
   cron_schedule: 0 4 * * *
   # The maximum age in days for a LogEntry before it will be removed
   max_log_age: 30
+  # Which Monolog\Logger levels (numberic) to start handling from (see class for examples)
+  minimum_log_level: 300 # WARNING

phpcs.xml.dist

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<ruleset>
+    <file>./src</file>
+    <file>./tests</file>
+    <rule ref="PSR2" />
+</ruleset>

src/Handler/DataObjectHandler.php

@@ -5,6 +5,7 @@
 use Monolog\Logger;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\AbstractProcessingHandler;
+use SilverStripe\Core\Config\Config;
 
 /**
  * The DataObjectHandler allows you to use a SilverStripe DataObject for handling Monolog log entries.
@@ -39,12 +40,13 @@ class DataObjectHandler extends AbstractProcessingHandler
 
     /**
      * @param string  $objectClass The DataObject class to use for handling the write
-     * @param int     $level       The minimum logging level at which this handler will be triggered
+     * @param int     $level       The minimum logging level at which this handler will be triggered (configurable)
      * @param boolean $bubble      Whether the messages that are handled can bubble up the stack or not
      */
     public function __construct($objectClass = self::DEFAULT_CLASS, $level = Logger::DEBUG, $bubble = true)
     {
         $this->setObjectClass($objectClass);
+        $level = $this->getMinimumLogLevel();
         parent::__construct($level, $bubble);
     }
 
@@ -104,4 +106,15 @@ public function getObjectClass()
     {
         return $this->objectClass;
     }
+
+    /**
+     * Get the minimum Monolog\Logger log level to start catching messages at
+     *
+     * @see \Monolog\Logger
+     * @return int
+     */
+    public function getMinimumLogLevel()
+    {
+        return (int) Config::inst()->get('LogViewer', 'minimum_log_level');
+    }
 }

tests/Handler/DataObjectHandlerTest.php

@@ -5,6 +5,7 @@
 use SilverLeague\LogViewer\Handler\DataObjectHandler;
 use SilverLeague\LogViewer\Model\LogEntry;
 use SilverStripe\Dev\SapphireTest;
+use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Injector\Injector;
 
 /**
@@ -39,6 +40,8 @@ public function setUp()
     {
         parent::setUp();
 
+        Config::nest();
+
         $this->logger = Injector::inst()->get('Logger');
 
         // Clear the default handlers so we can test precisely
@@ -48,17 +51,43 @@ public function setUp()
 
     /**
      * Test that arbitary log levels are all written to the database through the DataObjectHandler
-     *
-     * @covers \SilverLeague\LogViewer\Handler\DataObjectHandler
      */
     public function testWriteToDefaultLogger()
     {
         $this->logger->pushHandler(new DataObjectHandler);
-        $this->logger->addDebug('Hello world');
+        $this->logger->addError('Hello world');
 
         $logEntry = LogEntry::get()->first();
         $this->assertContains('Hello world', $logEntry->Entry);
-        $this->assertSame('DEBUG', $logEntry->Level);
+        $this->assertSame('ERROR', $logEntry->Level);
+    }
+
+    /**
+     * Test that logs are handled at a minimum level, but not lower than it.
+     */
+    public function testDontLogMessagesLowerThanMinimumLever()
+    {
+        Config::inst()->update('LogViewer', 'minimum_log_level', 300);
+        LogEntry::get()->removeAll();
+        $this->logger->pushHandler(new DataObjectHandler);
+
+        $this->logger->addDebug('Debug');
+        $this->assertSame(0, LogEntry::get()->count());
+
+        $this->logger->addWarning('Warning');
+        $this->assertGreaterThan(0, LogEntry::get()->filter('Level', 'WARNING')->count());
+
+        $this->logger->addAlert('Alert');
+        $this->assertGreaterThan(0, LogEntry::get()->filter('Level', 'ALERT')->count());
+    }
+
+    /**
+     * Test that the minumum log capture level is returned from configuration
+     */
+    public function testGetMinimumLogLevelFromConfiguration()
+    {
+        Config::inst()->update('LogViewer', 'minimum_log_level', 123);
+        $this->assertSame(123, (new DataObjectHandler)->getMinimumLogLevel());
     }
 
     /**
@@ -68,6 +97,8 @@ public function testWriteToDefaultLogger()
      */
     public function tearDown()
     {
+        Config::unnest();
+
         $this->logger->setHandlers($this->originalHandlers);
 
         parent::tearDown();