amylashley / traffic-logger
:package_description
Requires
- php: ~5.6|~7.0
Requires (Dev)
- phpunit/phpunit: >=5.4.3
- squizlabs/php_codesniffer: ^2.3
This package is not auto-updated.
Last update: 2024-11-16 16:49:56 UTC
README
Laravel package that will log certain traffic data to a MySQL database. This package relies on the Eloquent ORM which is included with Laravel.
Install
######Via Composer
$ composer require amylashley/traffic-logger
Add ServiceProvider to app.php
AmyLashley\TrafficLogger\App\Providers\TrafficLoggerServiceProvider::class,
Publish config and migration to your app:
php artisan vendor:publish --provider="AmyLashley\TrafficLogger\App\Providers\TrafficLoggerServiceProvider"
######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
######Add Middleware to your app\Http\Kernel.php in the global middleware array:
\AmyLashley\TrafficLogger\App\Http\Middleware\LogRequest::class,
##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 for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email alashley@amherst.edu instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.