amylashley/traffic-logger

:package_description

TrafficLogger

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Laravel package that will log certain traffic data to a MySQL database. This package relies on the Eloquent ORM which is included with Laravel., _(*2)

Install

Via Composer

``` bash $ composer require amylashley/traffic-logger, <sub>(*3)</sub>

Add ServiceProvider to app.php

AmyLashley\TrafficLogger\App\Providers\TrafficLoggerServiceProvider::class,, <sub>(*4)</sub>

Publish config and migration to your app:

php artisan vendor:publish --provider="AmyLashley\TrafficLogger\App\Providers\TrafficLoggerServiceProvider", <sub>(*5)</sub>

######Migrate the database.
You can change the database table that the logger users by update the table-name variable in the trafficlog.php config file.

php artisan migrate, <sub>(*6)</sub>

######Add Middleware to your `app\Http\Kernel.php` in the global middleware array:

\AmyLashley\TrafficLogger\App\Http\Middleware\LogRequest::class,, <sub>(*7)</sub>

##Configuration

The following can be configured in trafficlog.php:

-table-name: change the name of the database table that TrafficLogger will use. The default value is "log"
-impersonator: If your system uses impersonation, and you'd like to capture the id of the impersonator, you'll need to add this functionality to your system: add a session variable and populate it when your system authenticates the user being impersonated. Then you can use this variable in TrafficLogger. The default value is "auth_imitator".


## Usage

You can view your traffic reports at /admin/traffic-logger/report

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*8)</sub>

Security

If you discover any security related issues, please email alashley@amherst.edu instead of using the issue tracker., <sub>(*9)</sub>

Credits

• Amy Lashley
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>