vanlinhha/robots-counter

Count and report how many times a bot visit your website

1.0.2 2019-12-12 04:57 UTC

Requires

• jenssegers/agent: ^2.6

MIT

• Hà Văn Linh

README

This package allow you to track how many bots visit your website, their frequency and time execution for each request.

Installation

In your project folder, run

composer require vanlinhha/robots-counter

Aftef finish, publish vendor by this command:

php artisan vendor:publish --provider="LinhHa\RobotsCounter\RobotsCounterServiceProvider"

and php artisan migrate to run migration file

Usage Instructions

This package works by using a middleware, logging every request performed by bots in a log file, you can rename the middleware in config/robots_counter.php file.

If you want the middleware works for every request, just put its class \LinhHa\RobotsCounter\Middleware\RobotsCounterMiddleware::class in array $middleware in app/Http/Kernel.php But the best practise is using this middleware for routes need reporting for better performance. Also, you can config your accepted request methods you want to be in your log.

Logs are saved to database by command robot:report, this command is scheduled to run everyday. You can use it to make report for specific day, use php artisan robot:report --help to see usage.

We provide a route named api.robots.counter so you can easily make a report from it. This route uses GET method and accepts 3 parameters:
bot : bot name you want to make report
range: Range time you want to make report, m for last 30 days and w for last 7 days, the default value is w.
type: Report by day or by hour, day for by day and hour for by hour, default is hour.