Merge remote-tracking branch 'origin/develop'

Author: Wesley Elfring

README.md

@@ -12,21 +12,26 @@
 ## Logging exceptions
 The default settings enable logging of exceptions. It will add the HTTP request to the GELF message, but it will not add POST values. Check the graylog2.log-requests config to enable or disable this behavior.
 
+## Message Processors 
+Processors add extra functionality to the handler. You can register processors adding this to your AppServiceProvider:
+```php
+    Graylog2::registerProcessor(new \Swis\Graylog2\Processor\ExceptionProcessor());
+```
+In the default package, the following processors are available:
+### ExceptionProcessor
+Adds exception data to the message if there is any.
+### RequestProcessor
+Adds the current Laravel Request to the message. It adds the url, method and ip by default.
+
 ### Don't report exceptions
 In `app/Exceptions/Handler.php` you can define the $dontReport array with Exception classes that won't be reported to the logger. For example, you can blacklist the \Illuminate\Database\Eloquent\ModelNotFoundException. Check the [Laravel Documentation](https://laravel.com/docs/5.4/errors#the-exception-handler) about errors for more information.
 
-### Send default additional data
-Using the config, you can specify additional key => value data to be sent with the GELF message. For example, you can use this to add a client ID to a message.
-
 ## Logging arbitrary data
 You can instantiate the Graylog2 class to send additional GELF messages:
 
-```
-$graylog2 = app('graylog2');
-
-
+```php
 // Send default log message
-$graylog2->log('emergency', 'Dear Sir/Madam, Fire! Fire! Help me!. 123 Cavendon Road. Looking forward to hearing from you. Yours truly, Maurice Moss.', ['facility' => 'ICT']);
+Graylog2::log('emergency', 'Dear Sir/Madam, Fire! Fire! Help me!. 123 Cavendon Road. Looking forward to hearing from you. Yours truly, Maurice Moss.', ['facility' => 'ICT']);
 
 
 // Send custom GELF Message
@@ -36,7 +41,7 @@ $message->setShortMessage('Fire! Fire! Help me!');
 $message->setFullMessage('Dear Sir/Madam, Fire! Fire! Help me!. 123 Cavendon Road. Looking forward to hearing from you. Yours truly, Maurice Moss.');
 $message->setFacility('ICT');
 $message->setAdditional('employee', 'Maurice Moss');
-$graylog2->logMessage($message);
+Graylog2::logMessage($message);
 ```
 
 ## Troubleshooting

config/graylog2.php

@@ -5,15 +5,24 @@
     'enabled' => true,
 
     // Log HTTP requests with exceptions
-    'log-requests' => true,
+    'log_requests' => true,
+
+    // Log HTTP Request GET data
+    'log_request_get_data' => false,
+
+    // Log HTTP Request POST data
+    'log_request_post_data' => false,
+
+    // Filter out some sensitive post parameters
+    'disallowed_post_parameters' => ['password', 'username'],
 
     /*
      * Also add exception data in the full message.
      * This increases the size of the message by a lot. The
      * exception information is also included in the 'exception'
      * field.
      */
-    'exception-in-full-message' => false,
+    'stack_trace_in_full_message' => false,
 
     'connection' => [
         'host' => '127.0.0.1',
@@ -22,19 +31,5 @@
 
         // Set to UdpTransport::CHUNK_SIZE_LAN as a default
         'chunk_size' => '8154',
-    ],
-
-    /*
-     * Add additional context to the GELF message
-     */
-    'context' => [
-        'host' => 'localhost',
-        'version' => 'v1',
-        'facility' => 'default-facility',
-    ],
-
-    // Allows you to set additional fields in the GELF message, use key => value
-    'additional-fields' => [
-
     ]
 ];

src/Facades/Graylog2.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Swis\Graylog2\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class Graylog2 extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return 'graylog2';
+    }
+}

src/Graylog2.php

@@ -7,8 +7,8 @@
 use Gelf\Transport\TcpTransport;
 use Gelf\Transport\TransportInterface;
 use Gelf\Transport\UdpTransport;
-use Illuminate\Http\Request;
 use Psr\Log\AbstractLogger;
+use Swis\Graylog2\Processor\ProcessorInterface;
 
 class Graylog2 extends AbstractLogger
 {
@@ -18,31 +18,53 @@ class Graylog2 extends AbstractLogger
     /** @var Publisher */
     protected $publisher;
 
-    protected $context = [];
+    /** @var ProcessorInterface[] */
+    protected $processors = [];
 
     public function __construct()
     {
-        // Setup context for later use
-        $this->context = config('graylog2.context');
+        $this->setupGraylogTransport();
+    }
 
-        // Setup transport
-        if (config('graylog2.connection.type') === 'UDP') {
-            $transport = new UdpTransport(
-                config('graylog2.connection.host'),
-                config('graylog2.connection.port'),
-                config('graylog2.connection.chunk_size')
-            );
-        } else {
-            $transport = new TcpTransport(
-                config('graylog2.connection.host'),
-                config('graylog2.connection.port')
-            );
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed  $level
+     * @param string $message
+     * @param array  $context
+     */
+    public function log($level, $message, array $context = [])
+    {
+        $gelfMessage = $this->logger->prepareLog($level, $message, $context);
+        $exception = null;
+        if (array_key_exists('exception', $context)) {
+            $exception = $context['exception'];
         }
 
-        // Setup publisher and logger
-        $this->publisher = new Publisher();
-        $this->publisher->addTransport($transport);
-        $this->logger = new Logger($this->publisher, $this->context['facility']);
+        $gelfMessage = $this->invokeProcessors($gelfMessage, $exception, $context);
+        $this->logger->publishMessage($gelfMessage);
+    }
+
+    /**
+     * @param \Exception $exception
+     */
+    public function logException(\Exception $exception)
+    {
+        // Set short-message as it is a requirement
+        $message = new Message();
+        $message->setShortMessage(substr($exception->getMessage(), 0, 100));
+
+        $message = $this->invokeProcessors($message, $exception);
+        $this->logger->publishMessage($message);
+    }
+
+    /**
+     * @param Message $message
+     */
+    public function logGelfMessage(Message $message)
+    {
+        $message = $this->invokeProcessors($message);
+        $this->logger->publishMessage($message);
     }
 
     /**
@@ -56,44 +78,66 @@ public function addTransportToPublisher(TransportInterface $transport)
     }
 
     /**
-     * Send a message to Graylog.
+     * Set's the default facility on the logger/transport.
      *
-     * @param string $level
-     * @param string $message
-     * @param array  $context
+     * @param $facility
      */
-    public function log($level, $message, array $context = [])
+    public function setFacility($facility)
     {
-        $message = $this->logger->prepareLog($level, $message, $context);
-
-        if (!empty($this->context['host'])) {
-            $message->setHost($this->context['host']);
-        }
+        $this->logger->setFacility($facility);
+    }
 
-        if (!empty($context['request']) && $context['request'] instanceof Request) {
-            $message
-                ->setAdditional('request_url', $context['request']->url())
-                ->setAdditional('request_method', $context['request']->method())
-                ->setAdditional('request_ip', $context['request']->ip());
-        }
+    /**
+     * Allows you to refine the message before sending it to Graylog.
+     * You could add a callback to add the current user or other
+     * runtime info to the message.
+     *
+     * @param callable           $callback
+     * @param ProcessorInterface $processor
+     */
+    public function registerProcessor(ProcessorInterface $processor)
+    {
+        $this->processors[] = $processor;
+    }
 
-        // Add additionals from config
-        if (!empty(config('graylog2.additional-fields'))) {
-            foreach (config('graylog2.additional-fields') as $key => $value) {
-                $message->setAdditional($key, $value);
-            }
+    /**
+     * @param Message $message
+     * @param null    $exception
+     * @param mixed   $context
+     *
+     * @return Message
+     */
+    private function invokeProcessors(Message $message, $exception = null, $context = [])
+    {
+        foreach ($this->processors as $processor) {
+            $message = $processor->process($message, $exception, $context);
         }
 
-        $this->logger->publishMessage($message);
+        return $message;
     }
 
     /**
-     * Log an already constructed GELF message.
-     *
-     * @param Message $message
+     * Setup Graylog transport.
      */
-    public function logMessage(Message $message)
+    private function setupGraylogTransport()
     {
-        $this->logger->publishMessage($message);
+        // Setup the transport
+        if (config('graylog2.connection.type') === 'UDP') {
+            $transport = new UdpTransport(
+                config('graylog2.connection.host'),
+                config('graylog2.connection.port'),
+                config('graylog2.connection.chunk_size')
+            );
+        } else {
+            $transport = new TcpTransport(
+                config('graylog2.connection.host'),
+                config('graylog2.connection.port')
+            );
+        }
+
+        // Setup publisher and logger
+        $this->publisher = new Publisher();
+        $this->publisher->addTransport($transport);
+        $this->logger = new Logger($this->publisher);
     }
 }

src/Graylog2Handler.php

@@ -17,29 +17,22 @@ public function handle(array $record)
             return false;
         }
 
-        try {
-            /** @var Graylog2 $graylog2 */
-            $graylog2 = app('graylog2');
-
-            $context = array_merge(
-                $record['context'],
-                [
-                    'extra'   => $record['extra'],
-                    'channel' => $record['channel'],
-                ]
-            );
-
-            if (config('graylog2.log-requests')) {
-                $context['request'] = app('Illuminate\Http\Request');
-            }
+        // Handle a log from Laravel
+        /** @var Graylog2 $graylog2 */
+        $graylog2 = app('graylog2');
 
+        try {
             $graylog2->log(
                 strtolower($record['level_name']),
                 $record['message'],
-                $context
+                $record['context']
             );
+
+            return true;
         } catch (\Exception $e) {
-            Log::error('Cannot log the error to Graylog2.');
+            Log::info('Could not log to Graylog.');
+
+            return false;
         }
     }
 }

src/Graylog2ServiceProvider.php

@@ -23,12 +23,20 @@ public function boot()
      */
     public function register()
     {
-        $this->app->bind('graylog2', function ($app) {
-            return new Graylog2();
-        });
+        $this->app->singleton('graylog2', Graylog2::class);
 
         // Register handler
         $monoLog = Log::getMonolog();
         $monoLog->pushHandler(new Graylog2Handler());
     }
+
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return ['graylog2'];
+    }
 }