Merge pull request #11 from NBZ4live/feature/laravel-5.6

Implement new logging for Laravel/Lumen 5.6+

Author: Pavel Babushkin

config/jsonrpc.php

@@ -88,7 +88,13 @@
     /**
      * Настройки логгирования
      */
-    'log_max_files' => 10,
-    'log_path' => 'logs/jsonrpc/activity.log',
+    'logging_channel' => [
+        'name' => 'JsonRpc',
+        'tap' => [\Tochka\JsonRpc\Log\CustomizeLogger::class],
+        'driver' => 'daily',
+        'level' => 'debug',
+        'path' => storage_path('logs/jsonrpc/activity.log'),
+        'days' => 10,
+    ],
 
 ];

src/JsonRpcServiceProvider.php

@@ -3,9 +3,12 @@
 namespace Tochka\JsonRpc;
 
 use Illuminate\Http\Request;
+use Illuminate\Log\LogManager;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
+use Psr\Log\LoggerInterface;
 use Tochka\JsonRpc\Exceptions\JsonRpcHandler;
+use Tochka\JsonRpc\Log\Writer as JsonRpcLogWriter;
 
 class JsonRpcServiceProvider extends ServiceProvider
 {
@@ -19,8 +22,7 @@ public function register()
         // Необходимая вещь
         $this->app->instance('JsonRpcRequest', new JsonRpcRequest(new \StdClass, []));
 
-        // Кастомный логгер для api
-        $this->app->instance('JsonRpcLog', (new JsonRpcLogWriter())->createLogger());
+        $this->registerLogger();
 
         // Сервер JsonRpc
         $this->app->singleton('JsonRpcServer', function () {
@@ -47,6 +49,33 @@ public function boot()
         $this->publishes([__DIR__ . '/../config/jsonrpc.php' => config_path('jsonrpc.php')]);
     }
 
+    /**
+     * Register a custom logger instance for the api.
+     */
+    protected function registerLogger()
+    {
+        if (version_compare($this->getAppVersion(), '5.6', '>=')) {
+            /** @var LogManager $logManager */
+            $logManager = $this->app->make(LoggerInterface::class);
+
+            $channelConfig = $this->app['config']->get('jsonrpc.logging_channel', [
+                'name' => 'JsonRpc',
+                'tap' => [\Tochka\JsonRpc\Log\CustomizeLogger::class],
+                'driver' => 'daily',
+                'level' => 'debug',
+                'path' => \storage_path('logs/jsonrpc/activity.log'),
+                'days' => 10,
+            ]);
+
+            $this->app['config']->set('logging.channels.jsonrpc', $channelConfig);
+
+            $this->app->instance('JsonRpcLog', $logManager->channel('jsonrpc'));
+            return;
+        }
+
+        $this->app->instance('JsonRpcLog', (new JsonRpcLogWriter())->createLogger());
+    }
+
     protected function loadRoutes()
     {
         $routes = config('jsonrpc.routes', []);
@@ -93,4 +122,17 @@ function (Request $request, JsonRpcServer $server, $endpoint = null, $action = n
         }
     }
 
+    /**
+     * Get the version number of the application.
+     *
+     * @return string
+     */
+    protected function getAppVersion()
+    {
+        $version = $this->app->version();
+        if (substr($version, 0, 7) === 'Lumen (') {
+            $version = array_first(explode(')', str_replace('Lumen (', '', $version)));
+        }
+        return $version;
+    }
 }

src/Log/CustomizeLogger.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Tochka\JsonRpc\Log;
+
+use Monolog\Formatter\LineFormatter;
+use Monolog\Handler\HandlerInterface;
+use Monolog\Processor\MemoryUsageProcessor;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Class CustomizeLogger
+ * @package Tochka\JsonRpc\Log
+ */
+class CustomizeLogger
+{
+
+    const LINE_FORMAT = "[%datetime%] %level_name%: %message% %context% %extra%\n";
+
+    /**
+     * Customize the given logger instance.
+     *
+     * @param LoggerInterface $logger
+     * @return void
+     */
+    public function __invoke(LoggerInterface $logger)
+    {
+        /** @var HandlerInterface $handler */
+        foreach ($logger->getHandlers() as $handler) {
+            $handler->setFormatter(new LineFormatter(static::LINE_FORMAT, null, true, true));
+        }
+
+        $logger->pushProcessor(new JsonRpcProcessor());
+        $logger->pushProcessor(new MemoryUsageProcessor());
+    }
+}

src/JsonRpcProcessor.php renamed to src/Log/JsonRpcProcessor.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Tochka\JsonRpc;
+namespace Tochka\JsonRpc\Log;
 
 use Monolog\Processor\WebProcessor;
 

src/JsonRpcLogWriter.php renamed to src/Log/Writer.php

@@ -1,8 +1,7 @@
 <?php
 
-namespace Tochka\JsonRpc;
+namespace Tochka\JsonRpc\Log;
 
-use Illuminate\Log\Writer;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger as Monolog;
@@ -12,11 +11,9 @@
  * Class ApiLogWriter
  * @package App\Logger
  */
-class JsonRpcLogWriter extends Writer
+class Writer extends \Illuminate\Log\Writer
 {
 
-    const LINE_FORMAT = "[%datetime%] %level_name%: %message% %context% %extra%\n";
-
     public $log;
 
     public function __construct()
@@ -31,11 +28,11 @@ public function __construct()
      */
     public function createLogger()
     {
-        $path = storage_path(config('jsonrpc.log_path', 'logs/jsonrpc/activity.log'));
-        $numOfKeepFiles = config('jsonrpc.log_max_files', 10);
+        $path = config('jsonrpc.logging_channel.path', storage_path('logs/jsonrpc/activity.log'));
+        $numOfKeepFiles = config('jsonrpc.logging_channel.days', 10);
 
         $handler = new RotatingFileHandler($path, $numOfKeepFiles, $this->parseLevel('debug'), true, 0775);
-        $handler->setFormatter(new LineFormatter(static::LINE_FORMAT, null, true, true));
+        $handler->setFormatter(new LineFormatter(CustomizeLogger::LINE_FORMAT, null, true, true));
 
         $this->log->pushHandler($handler);
         $this->log->pushProcessor(new JsonRpcProcessor());