Merge pull request #6 from OnrampLab/issue-5-feat-support-attaching-uuid-to-logs

support attaching tracking id to logs

Close #5

Author: koshuang

README.md

@@ -1,26 +1,53 @@
 # laravel-log-enhancement
 
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
-[![CircleCI](https://circleci.com/gh/OnrampLab/next-starter.svg?style=shield)]()
+[![CircleCI](https://circleci.com/gh/OnrampLab/laravel-log-enhancement.svg?style=shield)](https://circleci.com/gh/OnrampLab/laravel-log-enhancement)
 [![Total Downloads](https://img.shields.io/packagist/dt/onramplab/laravel-log-enhancement.svg?style=flat-square)](https://packagist.org/packages/onramplab/laravel-log-enhancement)
 
 A library with logging enhancement. Including:
 
-  - `LogWithClassPath` trait
-    - It adds convinient methods for logging to add class path into context.
-  - `LogglyHandler` class
-    - It extends monolog's LogglyHandler with tags support
+- `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
 
 ## Install
 
 ```bash
 composer require onramplab/laravel-log-enhancement
 ```
 
-
 ## Usage
 
-### LogWithClassPath Trait
+### LoggerFacade
+
+Replace the class of `Log` alias to `LoggerFacade` in `config/app.php` as aliases.
+
+```php
+'Log' => Onramplab\LaravelLogEnhancement\Facades\LoggerFacade::class,
+```
+
+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"
+}
+```
+
+### LogWithClassPath Trait (*deprecated*)
+
 Use `LogWithClassPath` trait to let it automatically put class path into log context. You can refer to following code example.
 
 ```php
@@ -44,7 +71,8 @@ The log json will look like this:
 {
   "message": "Test",
   "context": {
-    "class_path": "App\\Fake"
+    "class_path": "App\\Fake",
+    "tracking_id": "652c3456-1a17-42b8-9fa7-9bee65e655eb"
   },
   "level": 200,
   "level_name": "INFO",
@@ -84,7 +112,6 @@ return [
 
 ```
 
-
 ## Testing
 
 Run the tests with:
@@ -93,17 +120,14 @@ Run the tests with:
 vendor/bin/phpunit
 ```
 
-
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-
 ## Security
 
 If you discover any security-related issues, please email kos.huang@onramplab.com instead of using the issue tracker.
 
-
 ## License
 
 The MIT License (MIT). Please see [License File](/LICENSE.md) for more information.# laravel-log-enhancement

composer.json

@@ -13,7 +13,8 @@
     "minimum-stability": "dev",
     "prefer-stable":true,
     "require": {
-        "monolog/monolog": "^1.12|^2.0"
+        "monolog/monolog": "^1.12|^2.0",
+        "ramsey/uuid": "^4.0.0"
     },
     "require-dev": {
         "fzaninotto/faker": "^1.9@dev",

src/Concerns/LogWithClassPath.php

@@ -2,7 +2,11 @@
 namespace Onramplab\LaravelLogEnhancement\Concerns;
 
 use Illuminate\Support\Facades\Log;
+use Onramplab\LaravelLogEnhancement\Logger;
 
+/**
+ * @deprecated deprecated since version 0.3.0
+ */
 trait LogWithClassPath {
     public function debug(string $message, array $context = [])
     {
@@ -47,11 +51,13 @@ public function emergency(string $message, array $context = [])
 
     protected function log(string $logLevel, string $message, array $context = [])
     {
+        $logger = app()->make(Logger::class);
+
         $className = get_class($this);
         $context = array_merge($context, [
             'class_path' => $className,
         ]);
 
-        Log::log($logLevel, $message, $context);
+        $logger->{$logLevel}($message, $context);
     }
 }

src/Facades/LoggerFacade.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+class LoggerFacade extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'laravel-log-enhancement-logger';
+    }
+}

src/LaravelLogEnhancementServiceProvider.php

@@ -2,8 +2,10 @@
 
 namespace Onramplab\LaravelLogEnhancement;
 
+use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Facades\Route;
+use Psr\Log\LoggerInterface;
 
 class LaravelLogEnhancementServiceProvider extends ServiceProvider
 {
@@ -57,8 +59,15 @@ private function routeConfiguration()
     public function register()
     {
         // Register facade
-        $this->app->singleton('laravel-log-enhancement', function () {
-            return new LaravelLogEnhancement;
+        // $this->app->singleton('laravel-log-enhancement', function () {
+        //     return new LaravelLogEnhancement;
+        // });
+        $this->app->singleton(Logger::class, function (Application $app) {
+            return new Logger($app->make(LoggerInterface::class));
+        });
+
+        $this->app->bind('laravel-log-enhancement-logger',function(){
+            return app()->make(Logger::class);
         });
     }
 

src/Logger.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement;
+
+use Psr\Log\LoggerInterface;
+use Ramsey\Uuid\Uuid;
+
+class Logger
+{
+    protected $debugId;
+    protected $logger;
+
+    /**
+     * Create an instance of the QueryLogger class
+     *
+     * @param \Psr\Log\LoggerInterface $logger
+     * @return void
+     *
+     * @throws \Ramsey\Uuid\Exception\UnsatisfiedDependencyException
+     * @throws \InvalidArgumentException
+     * @throws \Exception
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+        $this->debugId = Uuid::uuid4()->toString();
+        //
+    }
+
+    public function __call($name, $arguments)
+    {
+        $message = $arguments[0];
+        $context = $arguments[1] ?? [];
+
+        // attach caller class
+        $caller = debug_backtrace();
+        $caller = $caller[2];
+        $context['class_path'] = $caller['class'];
+
+        // attach tracking_id
+        $context['tracking_id'] = $this->debugId;
+
+        $this->logger->log($name, $message, $context);
+    }
+}

tests/Unit/LoggerTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Tests\Unit\Concerns;
+
+use Illuminate\Support\Facades\Log;
+use Onramplab\LaravelLogEnhancement\Tests\TestCase;
+use Onramplab\LaravelLogEnhancement\Logger;
+
+class LoggerTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @return void
+     */
+    public function log_should_include_class_path_and_uuid_in_context()
+    {
+      Log::spy();
+      $logger = app()->make(Logger::class);
+
+      $logger->info('123');
+
+      Log
+        ::shouldHaveReceived('log', function ($logLevel, $message, $context) {
+          return $logLevel === 'info'
+            && $message === '123'
+            && isSet($context['class_path'])
+            && isSet($context['tracking_id']);
+        })
+        ->once();
+    }
+}