rummykhan/xlog

A PHP Laravel package to log all the requests coming to your website

X-Log

, _(*1)

A PHP/Laravel Package to log all the requests, with the exceptions, country and city. It will help you get insight of your visitors activiy. Built on top of torann/geoip and jenssegers/agent, _(*2)

Installation

Install using composer:, _(*3)

composer require rummykhan/xlog

Add Service Providers

Add these two service provider in app/config/app.php:, _(*4)

\Torann\GeoIP\GeoIPServiceProvider::class,
RummyKhan\XLog\XLogServiceProvider::class,

Publish Configuration

Publish the configuration using command:, _(*5)

php artisan vendor:publish

Update geoip database

Update geoip database using command:, _(*6)

php artisan geoip:update

Add Middleware

Add XLogMiddleWare to your app\Http\Kernel.php as a web middleware group:, _(*7)

\RummyKhan\XLog\Http\Middleware\XLogMiddleware::class,

Migrate Log Table ( You don't have to migrate if your database is mongodb.)

Migrate Log Table migration:, _(*8)

php artisan migrate

Configure your application logging behavior

The php artisan vendor:publish will publish Log table migration into migrations folder, geoip.php and xlog.php in config folder of you laravel installation., _(*9)

Logging Environments

In xlog.php you may specify your igonore_environments as an array, In these environment it will not log any request or response e.g., _(*10)

'ignore_environments' => ['local', 'test'],

Set Database Type

In xlog.php you may specify your db_type as string. Since laravel supported databases (mysql, sqlite, pgsql) behaves differently than laravel not supported databases, For that purpose I'm using a ProxyModel Which switch the Eloquent Mode based on database type. E.g. For any laravel supported database you can leave it blank, For mongodb you can set it to 'mongo'., _(*11)

'db_type' => 'mongodb'

Supported database types are (sqlite, mysql, pgsql, mongodb)., _(*12)

DB Connection

In xlog.php you may specify your connection as string. This connection will be used to save the logs. (By default it uses application connection), _(*13)

'connection' => env('DB_CONNECTION')

Supported database types are (sqlite, mysql, pgsql, mongodb)., _(*14)

DB Table

In xlog.php you may specify the table_name for you logs., _(*15)

'table' => 'logs'

Log Display Routes

In xlog.php you may specify your routes. For now there are only three routes. 1. Index: where you can see the logs in tabular format using laravel pagination. 2. Detail: Where you can see the logs detail. 3. Delete: You can delete a log., _(*16)

( You may specify you own routes and controllers in case you want to. All you have to do is Call the RummyKhan\XLog\Models\Log Model to get the logs.), _(*17)

'routes' => [
    'index'  => [ 'route' => '/admin/logs',      'action' => 'XLogController@index'],        // HTTP Method is GET
    'detail' => [ 'route' => '/admin/logs/{id}', 'action' => 'XLogController@detail'],       // HTTP Method is GET
    'delete' => [ 'route' => '/admin/logs/{id}', 'action' => 'XLogController@delete']        // HTTP Method is DELETE
],

When changing routes, don't change the wildcard {id} from the routes., _(*18)

Log Middleware

In xlog.php you can specify the middleware for you log routes. By default middleware is set to auth., _(*19)

'middleware' => ['auth']

MIT Liscense

Laravel rummykhan/xlog is licensed under The MIT License (MIT)., _(*20)