blueant-allan/elasticlogger

A CakePHP custom log plugin for Cloudstaff

1.0 2021-02-11 08:11 UTC

Requires

• cakephp/cakephp: ^3.5

MIT

README

A CakePHP plugin for creating custom logs. Using CakePHP version 3.x

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require blueant-allan/ElasticLogger

Configuration

1. After installing the package in your project. You need to load the plugin, in your src/Application.php inside your bootstrap method add the following code to load the plugin.

public function bootstrap()
{
    // you loaded plugins here

    $this->addPlugin('ElasticLogger');
}

1. To start using the plugin, load the component in your controller initialize() method as such:

public function initialize(): void
{
    parent::initialize();

    // more of your controller initialize code here


    $this->loadComponent('ElasticLogger.Logcentral');
}

Usage

The component 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:

$this->Logcentral->activityInfo('EventType', 'your message');

Create an activity debug log:

$this->Logcentral->activityDebug('EventType', 'your message');

Create an activity Error log:

$this->Logcentral->activityError('EventType', 'your message');

Create an activity Notice log:

$this->Logcentral->activityNotice('EventType', 'your message');

Create an activity Warning log:

$this->Logcentral->activityWarning('EventType', 'your message');

Pass an array to your logs. Example below:

$data = [
    'id' => 42,
    'name' => 'Mark Tune',
    'roles' => ['Admin', 'Support']
];

$this->Logcentral->activityInfo('Login', 'User successfully logged in', $data);