blueant-allan / lumen-elasticlogger
A custom log package for Cloudstaff using Lumen microframework
Installs: 11
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:package
Requires
- laravel/lumen-framework: >5.0
README
A package for creating custom logs in Lumen microframework
Installation
You can install this package into your Lumen application using composer.
The recommended way to install composer packages is:
composer require blueant-allan/lumen-elasticlogger
Configuration
- After installing the package in your project. You can now instantiate the class by including the library as such.
use blueantallan\Lumen\ElasticLogger\Logger\BaseLogger; public function yourMethod() { $log = new BaseLogger(); $log->activityInfo('Event Type', 'Write my test log now.'); }
Usage
The library will expect the following parameters:
- EventType Can be use to describe the type of event being written to logs
- Message content message of your logs
- (Optional) this third parameter is optional. In case you need to pass a object or array, you may use this third parameter to add that object or array to your logs
Create an activity information log:
$log = new BaseLogger();
$log->activityInfo('EventType', 'your message');
Create an activity debug log:
$log->activityDebug('EventType', 'your message');
Create an activity Error log:
$log->activityError('EventType', 'your message');
Create an activity Notice log:
$log->activityNotice('EventType', 'your message');
Create an activity Warning log:
$log->activityWarning('EventType', 'your message');
Pass an array to your logs. Example below:
$data = [ 'id' => 42, 'name' => 'Mark Tune', 'roles' => ['Admin', 'Support'] ]; $log->activityInfo('Login', 'User successfully logged in', $data);