Merge branch 'release/v1.1.0'

Author: chelout

CHANGELOG.md

@@ -1,4 +1,13 @@
 # Changelog
 
-## 1.0.0 - 2018-04-04
+## [1.1.0] - 2018-04-19
+### Added
+- Log files (file name and size)
+- Log memory usage
+- Log peak memory usage
+- Log current git branch and commit
+### Changed
+- Date format config parametr name (dateFormat -> date_foramt)
+
+## [1.0.0] - 2018-04-04
 - Initial release

README.md

@@ -3,7 +3,7 @@
 [![Total Downloads](https://poser.pugx.org/chelout/laravel-http-logger/downloads)](https://packagist.org/packages/chelout/laravel-http-logger)
 [![License](https://poser.pugx.org/chelout/laravel-http-logger/license)](https://packagist.org/packages/chelout/laravel-http-logger)
 
-This package provides a middleware to log incoming http requests data (body data, headers and session data). It utilizes [Laravel 5.6 logging services](https://laravel.com/docs/5.6/logging) functionality.
+This package provides a middleware to log incoming http requests data (body data, files, headers and session data). It utilizes [Laravel 5.6 logging servises](https://laravel.com/docs/5.6/logging) functionality.
 This package might be useful to log user requests to public apis.
 
 ## Installation
@@ -46,7 +46,25 @@ return [
      * For for details see https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#customizing-the-log-format
      * and https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/LineFormatter.php
      */
-    'dateFormat' => null, // "Y-m-d\TH:i:sP"
+    'date_format' => null, // "Y-m-d\TH:i:sP"
+
+    /*
+     * Log current memory usage
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/MemoryUsageProcessor.php
+     */
+    'memory_usage' => true,
+
+    /*
+     * Log peak memory usage
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/MemoryPeakUsageProcessor.php
+     */
+    'memory_peak_usage' => true,
+
+    /*
+     * Log current git branch and commit
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/GitProcessor.php
+     */
+    'git' => true,
 
     /*
      * false - don't log body fields
@@ -61,6 +79,19 @@ return [
         'except' => [],
     ],
 
+    /*
+     * false - don't log uploaded files
+     * ['only'] - log files only
+     * ['except'] - don't log files
+     *
+     * If ['only'] is set, ['except'] parametr will be omitted
+     */
+    // 'files' => false,
+    'files' => [
+        'only' => [],
+        'except' => [],
+    ],
+
     /*
      * false - don't log headers
      * ['only'] - log headers only
@@ -152,7 +183,6 @@ return [
 
 ### Todo
 - tests
-- log file uploads
 - log git data?
 - log memory usage?
 

config/http-logger.php

@@ -12,17 +12,35 @@
 
     /*
      * Log message format.
-     * For for details see https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#customizing-the-log-format
-     * and https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/LineFormatter.php
+     * @see https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#customizing-the-log-format
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/LineFormatter.php
      */
     'format' => "[%datetime%] %extra.method% %extra.url% from %extra.ips% %context%\n",
 
     /*
      * Log message datetime format.
-     * For for details see https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#customizing-the-log-format
-     * and https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/LineFormatter.php
+     * @see https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#customizing-the-log-format
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/LineFormatter.php
      */
-    'dateFormat' => null, // "Y-m-d\TH:i:sP"
+    'date_format' => null, // "Y-m-d\TH:i:sP"
+
+    /*
+     * Log current memory usage
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/MemoryUsageProcessor.php
+     */
+    'memory_usage' => true,
+
+    /*
+     * Log peak memory usage
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/MemoryPeakUsageProcessor.php
+     */
+    'memory_peak_usage' => true,
+
+    /*
+     * Log current git branch and commit
+     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Processor/GitProcessor.php
+     */
+    'git' => true,
 
     /*
      * false - don't log body fields
@@ -37,6 +55,19 @@
         'except' => [],
     ],
 
+    /*
+     * false - don't log uploaded files
+     * ['only'] - log files only
+     * ['except'] - don't log files
+     *
+     * If ['only'] is set, ['except'] parametr will be omitted
+     */
+    // 'files' => false,
+    'files' => [
+        'only' => [],
+        'except' => [],
+    ],
+
     /*
      * false - don't log headers
      * ['only'] - log headers only

src/Loggers/HttpLogger.php

@@ -6,6 +6,9 @@
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
+use Monolog\Processor\GitProcessor;
+use Monolog\Processor\MemoryPeakUsageProcessor;
+use Monolog\Processor\MemoryUsageProcessor;
 
 class HttpLogger
 {
@@ -18,12 +21,24 @@ public function __invoke(array $config)
     {
         $logger = new Logger('http-logger');
 
+        if (config('http-logger.memory_usage')) {
+            $logger->pushProcessor(new MemoryUsageProcessor);
+        }
+
+        if (config('http-logger.memory_peak_usage')) {
+            $logger->pushProcessor(new MemoryPeakUsageProcessor);
+        }
+
+        if (config('http-logger.git')) {
+            $logger->pushProcessor(new GitProcessor);
+        }
+
         return $logger->pushProcessor(new RequestDataProcessor)
             ->pushHandler(
                 (new RotatingFileHandler(
                     config('http-logger.path'),
                     config('http-logger.max_files')
-                ))->setFormatter(new LineFormatter(config('http-logger.format'), config('http-logger.dateFormat'), true, true))
+                ))->setFormatter(new LineFormatter(config('http-logger.format'), config('http-logger.date_format'), true, true))
             );
     }
 }

src/Loggers/MonologCustomizer.php

@@ -3,6 +3,9 @@
 namespace Chelout\HttpLogger\Loggers;
 
 use Chelout\HttpLogger\Processors\RequestDataProcessor;
+use Monolog\Processor\GitProcessor;
+use Monolog\Processor\MemoryPeakUsageProcessor;
+use Monolog\Processor\MemoryUsageProcessor;
 
 class MonologCustomizer
 {
@@ -13,6 +16,18 @@ class MonologCustomizer
      */
     public function __invoke($logger)
     {
+        if (config('http-logger.memory_usage')) {
+            $logger->pushProcessor(new MemoryUsageProcessor);
+        }
+
+        if (config('http-logger.memory_peak_usage')) {
+            $logger->pushProcessor(new MemoryPeakUsageProcessor);
+        }
+
+        if (config('http-logger.git')) {
+            $logger->pushProcessor(new GitProcessor);
+        }
+
         return $logger->pushProcessor(new RequestDataProcessor);
     }
 }

src/Processors/RequestDataProcessor.php

@@ -14,6 +14,7 @@ public function __invoke($record): array
         return array_merge_recursive($record, [
             'context' => array_filter([
                 'data' => $this->processContext('data'),
+                'files' => $this->processContext('files'),
                 'headers' => $this->processContext('headers'),
                 'session' => $this->processContext('session'),
             ]),
@@ -64,13 +65,33 @@ protected function processContext(string $name): array
     }
 
     /**
-     * Get request body data.
+     * Get request body data except files.
      *
      * @return array
      */
     protected function getData(): array
     {
-        return request()->all();
+        return request()->except(
+            request()->files->keys()
+        );
+    }
+
+    /**
+     * Get files.
+     *
+     * @return array
+     */
+    protected function getFiles(): array
+    {
+        return collect(request()->files->all())
+            ->flatten()
+            ->map(function ($file) {
+                return [
+                    'name' => $file->getClientOriginalName(),
+                    'size' => $file->getClientSize(),
+                ];
+            })
+            ->toArray();
     }
 
     /**