benjamin-chen/table-activity-record

table action record for lumen framework

v0.1.5 2019-01-03 08:33 UTC

Requires

• php: >=7.1.3
• influxdb/influxdb-php: ^1.14
• laravel/lumen-framework: 5.7.*

Requires (Dev)

• phpunit/phpunit: ^7.5
• vlucas/phpdotenv: ^2.5

MIT

• benjamin

README

Requirements

• PHP >= 5.5.9
• lumen >= 5.7
• influxdb >= 1.7

Installation

Installation via Composer:

composer require benjamin-chen/table-activity-record

Configuration

Lumen 5.7

Add the Service Provider in bootstrap/app.php:

$app->register(BenjaminChen\TableActivityRecord\ServiceProvider::class);

Add env setting in .env:

INFLUXDB_HOST=your-influx-db-host
INFLUXDB_PORT=8086
INFLUXDB_DATABASE=your-influx-db-database

Add operate logging channel

'channels' => [
    'operate' => [
        'driver' => 'daily',
        'path' => storage_path('logs/operate/operate.log'),
    ]
],

Usage

Define model tags in model file:

class TestModel extends Model
{
    ...........

    public $tags = [
        'a', 'b', 'c'
    ];
}

Fire event after model executing create, update and delete methods

use BenjaminChen\TableActivityRecord\Events\TableActionEvent;

Event::fire(new TableActionEvent('create', $model));

Fire event will log your event data in storage/logs/operate/operate-yyyy-mm-dd.log and store the event record at influx-db.

You can use command php artisan operateRecord:check to check local log is the same with influx-db record

License

This package is open-source software and licensed under the MIT License.