Merge pull request #3 from wshafer/more-handlers

More handlers and dedup code
wshafer · Aug 29, 2017 · 6057b3b · 6057b3b
2 parents fbc01cc + bb7afaf
commit 6057b3b
Show file tree

Hide file tree

Showing 31 changed files with 504 additions and 472 deletions.
diff --git a/README.md b/README.md
@@ -70,6 +70,10 @@
             - [BufferHandler](#bufferhandler)
             - [GroupHandler](#grouphandler)
             - [FilterHandler](#filterhandler)
+            - [SamplingHandler](#samplinghandler)
+            - [NullHandler](#nullhandler)
+            - [PsrHandler](#psrhandler)
+            - [TestHandler](#testhandler)
     - [Formatters](#formatters)
         - [LineFomatter](#linefomatter)
         - [HtmlFormatter](#htmlformatter)
@@ -1661,7 +1665,7 @@ return [
     ],
 ];
 ```
-Monolog Docs: [DeduplicationHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/WhatFailureGroupHandler.php)
+Monolog Docs: [WhatFailureGroupHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/WhatFailureGroupHandler.php)
 
 
 #### BufferHandler
@@ -1713,7 +1717,7 @@ return [
     ],
 ];
 ```
-Monolog Docs: [DeduplicationHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/GroupHandler.php)
+Monolog Docs: [GroupHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/GroupHandler.php)
 
 
 #### FilterHandler
@@ -1741,6 +1745,105 @@ return [
 Monolog Docs: [FilterHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/FilterHandler.php)
 
 
+#### SamplingHandler
+A sampled event stream can be useful for logging high frequency events in
+a production environment where you only need an idea of what is happening
+and are not concerned with capturing every occurrence. Since the decision to
+handle or not handle a particular event is determined randomly, the
+resulting sampled log is not guaranteed to contain 1/N of the events that
+occurred in the application, but based on the Law of large numbers, it will
+tend to be close to this ratio with a large number of attempts.
+
+```php
+<?php
+
+return [
+    'monolog' => [
+        'handlers' => [
+            'myHandlerName' => [
+                'type' => 'sampling',
+                'options' => [
+                    'handler' => 'my-handler', // Required: Registered Handler to wrap
+                    'factor'  => 5,            // Required: Sample factor
+                ],
+            ],
+        ],
+    ],
+];
+```
+Monolog Docs: [SamplingHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/SamplingHandler.php)
+
+
+#### NullHandler
+Any record it can handle will be thrown away. This can be used
+to put on top of an existing stack to override it temporarily.
+
+```php
+<?php
+
+return [
+    'monolog' => [
+        'handlers' => [
+            'myHandlerName' => [
+                'type'    => 'noop',
+                'options' => [
+                    'level' => \Monolog\Logger::DEBUG, // Optional: The minimum logging level at which this handler will be triggered
+                ],
+            ],
+        ],
+    ],
+];
+```
+Monolog Docs: [NullHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/NullHandler.php)
+
+
+#### PsrHandler
+Can be used to forward log records to an existing PSR-3 logger
+
+```php
+<?php
+
+return [
+    'monolog' => [
+        'handlers' => [
+            'myHandlerName' => [
+                'type'    => 'psr',
+                'options' => [
+                    'logger' => 'loggerService',        // Required: Logger Service to wrap from the container
+                    'level'  => \Monolog\Logger::DEBUG, // Optional: The minimum logging level at which this handler will be triggered
+                    'bubble' => true,                   // Optional: Whether the messages that are handled can bubble up the stack or not
+                ],
+            ],
+        ],
+    ],
+];
+```
+Monolog Docs: [PsrHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/PsrHandler.php)
+
+
+#### TestHandler
+Used for testing, it records everything that is sent to it and has accessors to read out the information.
+
+```php
+<?php
+
+return [
+    'monolog' => [
+        'handlers' => [
+            'myHandlerName' => [
+                'type'    => 'test',
+                'options' => [
+                    'level'  => \Monolog\Logger::DEBUG, // Optional: The minimum logging level at which this handler will be triggered
+                    'bubble' => true,                   // Optional: Whether the messages that are handled can bubble up the stack or not
+                ],
+            ],
+        ],
+    ],
+];
+```
+Monolog Docs: [TestHandler](https://github.com/Seldaek/monolog/blob/master/src/Monolog/Handler/TestHandler.php)
+
+
 ## Formatters
 
 ### LineFomatter

diff --git a/src/ClientTrait.php b/src/ClientTrait.php
diff --git a/src/Handler/AmqpHandlerFactory.php b/src/Handler/AmqpHandlerFactory.php
@@ -5,20 +5,17 @@
 
 use Monolog\Handler\AmqpHandler;
 use Monolog\Logger;
-use PhpAmqpLib\Channel\AMQPChannel;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
-use WShafer\PSR11MonoLog\ContainerTrait;
-use WShafer\PSR11MonoLog\Exception\MissingConfigException;
-use WShafer\PSR11MonoLog\Exception\MissingServiceException;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class AmqpHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ContainerTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $exchange     = $this->getAmqpExchange($options);
+        $exchange     = $this->getService($options['exchange'] ?? null);
         $exchangeName = (string)  ($options['exchangeName'] ?? 'log');
         $level        = (int)     ($options['level']     ?? Logger::DEBUG);
         $bubble       = (boolean) ($options['bubble']    ?? true);
@@ -30,25 +27,4 @@ public function __invoke(array $options)
             $bubble
         );
     }
-
-    /**
-     * @param $options
-     * @return \AMQPExchange|AMQPChannel
-     */
-    public function getAmqpExchange($options)
-    {
-        if (empty($options['exchange'])) {
-            throw new MissingConfigException(
-                'No exchange service name'
-            );
-        }
-
-        if (!$this->getContainer()->has($options['exchange'])) {
-            throw new MissingServiceException(
-                'No exchange service found for :'.$options['exchange']
-            );
-        }
-
-        return $this->getContainer()->get($options['exchange']);
-    }
 }
diff --git a/src/Handler/DoctrineCouchDBHandlerFactory.php b/src/Handler/DoctrineCouchDBHandlerFactory.php
@@ -5,17 +5,17 @@
 
 use Monolog\Handler\DoctrineCouchDBHandler;
 use Monolog\Logger;
-use WShafer\PSR11MonoLog\ClientTrait;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class DoctrineCouchDBHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ClientTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $client  = $this->getClient($options);
+        $client  = $this->getService($options['client'] ?? null);
         $level   = (int)     ($options['level']   ?? Logger::DEBUG);
         $bubble  = (boolean) ($options['bubble']  ?? true);
 

diff --git a/src/Handler/DynamoDbHandlerFactory.php b/src/Handler/DynamoDbHandlerFactory.php
@@ -5,17 +5,17 @@
 
 use Monolog\Handler\DynamoDbHandler;
 use Monolog\Logger;
-use WShafer\PSR11MonoLog\ClientTrait;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class DynamoDbHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ClientTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $client  = $this->getClient($options);
+        $client  = $this->getService($options['client'] ?? null);
         $table   =            $options['table']  ?? null;
         $level   = (int)     ($options['level']  ?? Logger::DEBUG);
         $bubble  = (boolean) ($options['bubble'] ?? true);

diff --git a/src/Handler/ElasticSearchHandlerFactory.php b/src/Handler/ElasticSearchHandlerFactory.php
@@ -5,17 +5,17 @@
 
 use Monolog\Handler\ElasticSearchHandler;
 use Monolog\Logger;
-use WShafer\PSR11MonoLog\ClientTrait;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class ElasticSearchHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ClientTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $client      = $this->getClient($options);
+        $client      = $this->getService($options['client'] ?? null);
         $index       = (string)  ($options['index']       ?? 'monolog');
         $type        = (string)  ($options['type']        ?? 'record');
         $ignoreError = (boolean) ($options['ignoreError'] ?? false);

diff --git a/src/Handler/GelfHandlerFactory.php b/src/Handler/GelfHandlerFactory.php
@@ -7,18 +7,18 @@
 use Monolog\Handler\GelfHandler;
 use Monolog\Logger;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
-use WShafer\PSR11MonoLog\ContainerTrait;
 use WShafer\PSR11MonoLog\Exception\MissingConfigException;
 use WShafer\PSR11MonoLog\Exception\MissingServiceException;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class GelfHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ContainerTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $publisher = $this->getPublisher($options);
+        $publisher = $this->getService($options['publisher'] ?? mull);
         $level     = (int)     ($options['level']     ?? Logger::DEBUG);
         $bubble    = (boolean) ($options['bubble']    ?? true);
 
@@ -28,25 +28,4 @@ public function __invoke(array $options)
             $bubble
         );
     }
-
-    /**
-     * @param $options
-     * @return PublisherInterface
-     */
-    public function getPublisher($options)
-    {
-        if (empty($options['publisher'])) {
-            throw new MissingConfigException(
-                'No exchange service name'
-            );
-        }
-
-        if (!$this->getContainer()->has($options['publisher'])) {
-            throw new MissingServiceException(
-                'No publisher service found for :'.$options['publisher']
-            );
-        }
-
-        return $this->getContainer()->get($options['publisher']);
-    }
 }
diff --git a/src/Handler/HandlerMapper.php b/src/Handler/HandlerMapper.php
@@ -103,6 +103,14 @@ public function map(string $type)
                 return GroupHandlerFactory::class;
             case 'filter':
                 return FilterHandlerFactory::class;
+            case 'sampling':
+                return SamplingHandlerFactory::class;
+            case 'null':
+                return NullHandlerFactory::class;
+            case 'psr':
+                return PsrHandlerFactory::class;
+            case 'test':
+                return TestHandlerFactory::class;
         }
 
         return null;

diff --git a/src/Handler/MongoDBHandlerFactory.php b/src/Handler/MongoDBHandlerFactory.php
@@ -5,17 +5,17 @@
 
 use Monolog\Handler\MongoDBHandler;
 use Monolog\Logger;
-use WShafer\PSR11MonoLog\ClientTrait;
 use WShafer\PSR11MonoLog\ContainerAwareInterface;
 use WShafer\PSR11MonoLog\FactoryInterface;
+use WShafer\PSR11MonoLog\ServiceTrait;
 
 class MongoDBHandlerFactory implements FactoryInterface, ContainerAwareInterface
 {
-    use ClientTrait;
+    use ServiceTrait;
 
     public function __invoke(array $options)
     {
-        $client     = $this->getClient($options);
+        $client     = $this->getService($options['client'] ?? null);
         $database   = (string)  ($options['database']   ?? '');
         $collection = (string)  ($options['collection'] ?? '');
         $level      = (int)     ($options['level']      ?? Logger::DEBUG);

diff --git a/src/Handler/NullHandlerFactory.php b/src/Handler/NullHandlerFactory.php
@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace WShafer\PSR11MonoLog\Handler;
+
+use Monolog\Handler\NullHandler;
+use Monolog\Logger;
+use WShafer\PSR11MonoLog\FactoryInterface;
+
+class NullHandlerFactory implements FactoryInterface
+{
+    public function __invoke(array $options)
+    {
+        $level = (int) ($options['level'] ?? Logger::DEBUG);
+
+        return new NullHandler($level);
+    }
+}