Merge pull request #4 from OnrampLab/issue-3-feat-loggly-handler

loggly handler

Close #3

Author: koshuang

README.md

@@ -4,6 +4,12 @@
 [![CircleCI](https://circleci.com/gh/OnrampLab/next-starter.svg?style=shield)]()
 [![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
 
 ## Install
 
@@ -14,6 +20,7 @@ composer require onramplab/laravel-log-enhancement
 
 ## Usage
 
+### LogWithClassPath Trait
 Use `LogWithClassPath` trait to let it automatically put class path into log context. You can refer to following code example.
 
 ```php
@@ -47,8 +54,36 @@ The log json will look like this:
 }
 ```
 
+### LogglyHandler
+
+You can adding following block into `config/logging.php`.
+
+```php
+use Monolog\Formatter\LogglyFormatter;
+use Onramplab\LaravelLogEnhancement\Handlers\LogglyHandler;
+
+return [
+  //...
 
 
+  'channels' => [
+    //...
+
+    'loggly' => [
+        'driver' => 'monolog',
+        'level' => 'info',
+        'handler' => LogglyHandler::class,
+        'handler_with' => [
+            'token' => env('LOGGLY_TOKEN'),
+            'tags' => env('LOGGLY_TAGS'),
+        ],
+        'formatter' => LogglyFormatter::class,
+    ],
+  ]
+];
+
+```
+
 
 ## Testing
 

composer.json

@@ -12,7 +12,9 @@
     ],
     "minimum-stability": "dev",
     "prefer-stable":true,
-    "require": {},
+    "require": {
+        "monolog/monolog": "^1.12|^2.0"
+    },
     "require-dev": {
         "fzaninotto/faker": "^1.9@dev",
         "illuminate/support": "^7.0",

src/Handlers/LogglyHandler.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Handlers;
+
+use Monolog\Logger;
+use Monolog\Handler\LogglyHandler as BaseLogglyHandler;
+
+class LogglyHandler extends BaseLogglyHandler
+{
+    public function __construct($token, $tags, $level = Logger::DEBUG, $bubble = true)
+    {
+        parent::__construct($token, $level, $bubble);
+
+        $tagsList = explode(',', $tags);
+        $this->setTag($tagsList);
+    }
+}

tests/Unit/Handlers/LogglyHandlerTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Onramplab\LaravelLogEnhancement\Tests\Unit\Handlers;
+
+use Onramplab\LaravelLogEnhancement\Tests\TestCase;
+use Mockery;
+use Onramplab\LaravelLogEnhancement\Handlers\LogglyHandler;
+
+class LogglyHandlerTest extends TestCase
+{
+    /**
+     * @test
+     *
+     * @return void
+     */
+    public function constructor_should_support_tags()
+    {
+      $this->handler = Mockery::mock(LogglyHandler::class)->makePartial();
+
+      $this->handler->shouldReceive('setTag')->with(['tag1', 'tag2'])->once();
+
+      $this->handler->__construct('test', 'tag1,tag2');
+    }
+}