Merge pull request #8 from OnrampLab/issue-7-feat-log-facade-should-be-compatible-with-laravel-default-one

LogFacade should be compatible with laravel default one

Close #7

Author: koshuang

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[composer.json]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+
+[*.php]
+indent_size = 4

README.md

@@ -8,8 +8,6 @@ A library with logging enhancement. Including:
 
 - `LoggerFacade` facade
   - It extends default Laravel `Log` facade with logging adding class path and tracking id into context.
-- `LogWithClassPath` trait (*deprecated*)
-  - It adds convinient methods for logging to add class path and tracking id into context.
 - `LogglyHandler` class
   - It extends monolog's LogglyHandler with tags support
 
@@ -46,42 +44,6 @@ The log json will look like this:
 }
 ```
 
-### LogWithClassPath Trait (*deprecated*)
-
-Use `LogWithClassPath` trait to let it automatically put class path into log context. You can refer to following code example.
-
-```php
-namespace App;
-
-use Onramplab\LaravelLogEnhancement\Concerns\LogWithClassPath;
-
-class Fake {
-  use LogWithClassPath;
-
-  public function run()
-  {
-    $this->info('Test');
-  }
-}
-```
-
-The log json will look like this:
-
-```json
-{
-  "message": "Test",
-  "context": {
-    "class_path": "App\\Fake",
-    "tracking_id": "652c3456-1a17-42b8-9fa7-9bee65e655eb"
-  },
-  "level": 200,
-  "level_name": "INFO",
-  "channel": "local",
-  "extra": {},
-  "timestamp": "2021-01-04T22:47:56.598608-0800"
-}
-```
-
 ### LogglyHandler
 
 You can adding following block into `config/logging.php`.

composer.json

@@ -18,6 +18,8 @@
     },
     "require-dev": {
         "fzaninotto/faker": "^1.9@dev",
+        "illuminate/contracts": "^7.0",
+        "illuminate/log": "^7.0",
         "illuminate/support": "^7.0",
         "mockery/mockery": "^1.3.2",
         "orchestra/database": "^5.0",

src/Concerns/LogWithClassPath.php

@@ -66,8 +66,8 @@ public function register()
             return new Logger($app->make(LoggerInterface::class));
         });
 
-        $this->app->bind('laravel-log-enhancement-logger',function(){
-            return app()->make(Logger::class);
+        $this->app->singleton('laravel-log-enhancement-logger', function ($app) {
+            return new LogManager($app);
         });
     }
 

src/LaravelLogEnhancementServiceProvider.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement;
+
+use Illuminate\Log\LogManager as IlluminateLoggerManager;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger as Monolog;
+use Psr\Log\LoggerInterface;
+use Throwable;
+
+/**
+ * Replace with our custom Logger
+ */
+class LogManager extends IlluminateLoggerManager
+{
+    /**
+     * Create an emergency log handler to avoid white screens of death.
+     *
+     * @return \Psr\Log\LoggerInterface
+     */
+    protected function createEmergencyLogger()
+    {
+        $config = $this->configurationFor('emergency');
+
+        $handler = new StreamHandler(
+            $config['path'] ?? $this->app->storagePath().'/logs/laravel.log',
+            $this->level(['level' => 'debug'])
+        );
+
+        return new Logger(
+            new Monolog('laravel', $this->prepareHandlers([$handler])),
+            $this->app['events']
+        );
+    }
+
+    /**
+     * Create a new, on-demand aggregate logger instance.
+     *
+     * @param  array  $channels
+     * @param  string|null  $channel
+     * @return \Psr\Log\LoggerInterface
+     */
+    public function stack(array $channels, $channel = null)
+    {
+        return new Logger(
+            $this->createStackDriver(compact('channels', 'channel')),
+            $this->app['events']
+        );
+    }
+
+    /**
+     * Attempt to get the log from the local cache.
+     *
+     * @param  string  $name
+     * @return \Psr\Log\LoggerInterface
+     */
+    protected function get($name)
+    {
+        try {
+            return $this->channels[$name] ?? with($this->resolve($name), function ($logger) use ($name) {
+                return $this->channels[$name] = $this->tap($name, new Logger($logger, $this->app['events']));
+            });
+        } catch (Throwable $e) {
+            return tap($this->createEmergencyLogger(), function ($logger) use ($e) {
+                $logger->emergency('Unable to create configured logger. Using emergency logger.', [
+                    'exception' => $e,
+                ]);
+            });
+        }
+    }
+}

src/LogManager.php

@@ -2,44 +2,77 @@
 
 namespace Onramplab\LaravelLogEnhancement;
 
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Log\Logger as IlluminateLogger;
 use Psr\Log\LoggerInterface;
 use Ramsey\Uuid\Uuid;
 
-class Logger
+class Logger extends IlluminateLogger
 {
+    /**
+     * @var string
+     */
     protected $debugId;
+
+    /**
+     * LoggerInterface
+     */
     protected $logger;
 
     /**
-     * Create an instance of the QueryLogger class
+     * @var string
+     */
+    protected $channelName;
+
+    /**
+     * Create a new log writer instance.
      *
-     * @param \Psr\Log\LoggerInterface $logger
+     * @param  \Psr\Log\LoggerInterface  $logger
+     * @param  \Illuminate\Contracts\Events\Dispatcher|null  $dispatcher
      * @return void
-     *
-     * @throws \Ramsey\Uuid\Exception\UnsatisfiedDependencyException
-     * @throws \InvalidArgumentException
-     * @throws \Exception
      */
-    public function __construct(LoggerInterface $logger)
+    public function __construct(LoggerInterface $logger, Dispatcher $dispatcher = null)
     {
         $this->logger = $logger;
+        $this->dispatcher = $dispatcher;
         $this->debugId = Uuid::uuid4()->toString();
-        //
     }
 
-    public function __call($name, $arguments)
+    /**
+     * Write a message to the log.
+     *
+     * @param  string  $level
+     * @param  string  $message
+     * @param  array  $context
+     * @return void
+     */
+    protected function writeLog($level, $message, $context)
     {
-        $message = $arguments[0];
-        $context = $arguments[1] ?? [];
+        $info = $this->generateExtraContextInfo();
+        $context = array_merge($context, $info);
+
+        parent::writeLog($level, $message, $context);
+    }
+
+    protected function generateExtraContextInfo()
+    {
+        $info = [];
+
+        // attach class_path
+        // NOTE: it's hardcoded, should find a better way to get caller class
+        $stack = debug_backtrace();
+        $caller = $stack[2];
+
+        if ($caller['class'] === 'Illuminate\Log\LogManager') {
+            // It means log from channel
+            $caller = $stack[4];
+        }
 
-        // attach caller class
-        $caller = debug_backtrace();
-        $caller = $caller[2];
-        $context['class_path'] = $caller['class'];
+        $info['class_path'] = $caller['class'];
 
         // attach tracking_id
-        $context['tracking_id'] = $this->debugId;
+        $info['tracking_id'] = $this->debugId;
 
-        $this->logger->log($name, $message, $context);
+        return $info;
     }
 }

src/Logger.php

@@ -15,10 +15,10 @@ class LogglyHandlerTest extends TestCase
      */
     public function constructor_should_support_tags()
     {
-      $this->handler = Mockery::mock(LogglyHandler::class)->makePartial();
+        $this->handler = Mockery::mock(LogglyHandler::class)->makePartial();
 
-      $this->handler->shouldReceive('setTag')->with(['tag1', 'tag2'])->once();
+        $this->handler->shouldReceive('setTag')->with(['tag1', 'tag2'])->once();
 
-      $this->handler->__construct('test', 'tag1,tag2');
+        $this->handler->__construct('test', 'tag1,tag2');
     }
 }