Tracker

A Laravel Visitor Stats Tracker

Tracker gathers a lot of information from your requests to identify and store:

• Sessions
• Page Views (hits on routes)
• Users (logged users)
• Devices (computer, smartphone, tablet...)
• Languages (preference, language range)
• User Devices (by, yeah, storing a cookie on each device)
• Browsers (Chrome, Mozilla Firefox, Safari, Internet Explorer...)
• Operating Systems (iOS, Mac OS, Linux, Windows...)
• Geo Location Data (Latitute, Longitude, Country and City)
• Routes and all its parameters
• Events
• Referers (url, medium, source, search term...)
• Exceptions/Errors
• Sql queries and all its bindings
• Url queries and all its arguments
• Database connections

Index

• Why?
• How To Use It
• Screenshots
• Blade Views
• Table Schemas
• System Requirements
• Installing
• Upgrading
• Changelog
• Contributing

Why?

Storing user tracking information, on indexed and normalized database tables, wastes less disk space and ease the extract of valuable information about your application and business.

Usage

As soon as you install and enable it, Tracker will start storing all information you tell it to, then you can in your application use the Tracker Facade to access everything. Here are some of the methods and relatioships available:

Current Session/Visitor

$visitor = Tracker::currentSession();

Most of those methods return an Eloquent model or collection, so you can use not only its attributes, but also relational data:

var_dump( $visitor->client_ip );

var_dump( $visitor->device->is_mobile );

var_dump( $visitor->device->platform );

var_dump( $visitor->geoIp->city );

var_dump( $visitor->language->preference );

Sessions (visits)

$sessions = Tracker::sessions(60 * 24); // get sessions (visits) from the past day

foreach ($sessions as $session)
{
    var_dump( $session->user->email );

    var_dump( $session->device->kind . ' - ' . $session->device->platform );

    var_dump( $session->agent->browser . ' - ' . $session->agent->browser_version );

    var_dump( $session->geoIp->country_name );

    foreach ($session->session->log as $log)
    {
    	var_dump( $log->path );
    }
}

Online Users

Brings all online sessions (logged and unlogged users)

$users = Tracker::onlineUsers(); // defaults to 3 minutes

Users

$users = Tracker::users(60 * 24);

User Devices

$users = Tracker::userDevices(60 * 24, $user->id);

Events

$events = Tracker::events(60 * 24);

Errors

$errors = Tracker::errors(60 * 24);

PageViews summary

$pageViews = Tracker::pageViews(60 * 24 * 30);

PageViews By Country summary

$pageViews = Tracker::pageViewsByCountry(60 * 24);

Filter range

You can send timestamp ranges to those methods using the Minutes class:

$range = new Minutes();

$range->setStart(Carbon::now()->subDays(2));

$range->setEnd(Carbon::now()->subDays(1));

Tracker::userDevices($range);

Routes By Name

Having a route of

Route::get('user/{id}', ['as' => 'user.profile', 'use' => 'UsersController@profile']);

You can use this method to select all hits on that particular route and count them using Laravel:

return Tracker::logByRouteName('user.profile')
        ->where(function($query)
        {
            $query
                ->where('parameter', 'id')
                ->where('value', 1);
        })
        ->count();

And if you need count how many unique visitors accessed that route, you can do:

return Tracker::logByRouteName('tracker.stats.log')
        ->where(function($query)
        {
            $query
                ->where('parameter', 'uuid')
                ->where('value', '8b6faf82-00f1-4db9-88ad-32e58cfb4f9d');
        })
        ->select('tracker_log.session_id')
        ->groupBy('tracker_log.session_id')
        ->distinct()
        ->count('tracker_log.session_id');

Screenshots

Visits

Charts

Users

Events

Errors

Blade Views

The views above are available in this package, but you need to install the sb-admin panel on your public folder, please look at the instructions below.

How data is stored

All tables are prefixed by tracker_, and here's an extract of some of them, showing columns and contents:

sessions

+-----+--------------------------------------+---------+-----------+----------+-----------------+------------+-----------+----------+-------------+
| id  | uuid                                 | user_id | device_id | agent_id | client_ip       | referer_id | cookie_id | geoip_id | language_id |
+-----+--------------------------------------+---------+-----------+----------+-----------------+------------+-----------+----------+-------------+
| 1   | 09465be3-5930-4581-8711-5161f62c4373 | 1       | 1         | 1        | 186.228.127.245 | 2          | 1         | 2        | 3           |
| 2   | 07399969-0a19-47f0-862d-43b06d7cde45 |         | 2         | 2        | 66.240.192.138  |            | 2         | 2        | 2           |
+-----+--------------------------------------+---------+-----------+----------+-----------------+------------+-----------+----------+-------------+

devices

+----+----------+-------------+-------------+------------------+-----------+
| id | kind     | model       | platform    | platform_version | is_mobile |
+----+----------+-------------+-------------+------------------+-----------+
| 1  | Computer | unavailable | Windows 8   |                  |           |
| 2  | Tablet   | iPad        | iOS         | 7.1.1            | 1         |
| 3  | Computer | unavailable | Windows XP  |                  |           |
| 5  | Computer | unavailable | Other       |                  |           |
| 6  | Computer | unavailable | Windows 7   |                  |           |
| 7  | Computer | unavailable | Windows 8.1 |                  |           |
| 8  | Phone    | iPhone      | iOS         | 7.1              | 1         |
+----+----------+-------------+-------------+------------------+-----------+

agents

+----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------+-----------------+
| id | name                                                                                                                                    | browser           | browser_version |
+----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------+-----------------+
| 1  | Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.114 Safari/537.36                           | Chrome            | 35.0.1916       |
| 2  | Mozilla/5.0 (iPad; CPU OS 7_1_1 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) CriOS/34.0.1847.18 Mobile/11D201 Safari/9537.53 | Chrome Mobile iOS | 34.0.1847       |
| 3  | Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)                                                                                      | IE                | 6.0             |
| 4  | Python-urllib/2.6                                                                                                                       | Other             |                 |
| 5  | Other                                                                                                                                   | Other             |                 |
| 6  | Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/34.0.1847.137 Safari/537.36                           | Chrome            | 34.0.1847       |
| 7  | Mozilla/5.0 (Windows NT 6.3; rv:28.0) Gecko/20100101 Firefox/28.0                                                                       | Firefox           | 28.0            |
| 8  | Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit/537.51.2 (KHTML, like Gecko) Version/7.0 Mobile/11D169 Safari/9537.53 | Mobile Safari     | 7.0             |
+----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------+-----------------+

languages

+----+------------+----------------+
| id | preference | language_range |
+----+------------+----------------+
| 1  | en         | ru=0.8,es=0.5  |
| 2  | es         | en=0.7,ru=0.3  |
| 3  | ru         | en=0.5,es=0.5  |
+----+------------+----------------+

domains

+----+--------------------------+
| id | name                     |
+----+--------------------------+
| 1  | antoniocarlosribeiro.com |
+----+--------------------------+

errors

+----+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | code | message                                                                                                                                                                                                                      |
+----+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 1  | 404  |                                                                                                                                                                                                                              |
| 2  | 500  | Call to undefined method PragmaRX\Tracker\Tracker::sessionLog()                                                                                                                                                              |
| 3  | 500  | Trying to get property of non-object (View: /home/forge/stage.antoniocarlosribeiro.com/app/views/admin/tracker/log.blade.php)                                                                                                |
| 4  | 500  | syntax error, unexpected 'foreach' (T_FOREACH)                                                                                                                                                                               |
| 5  | 500  | Call to undefined method PragmaRX\Tracker\Tracker::pageViewsByCountry()                                                                                                                                                      |
| 6  | 500  | Class PragmaRX\Firewall\Vendor\Laravel\Artisan\Base contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Illuminate\Console\Command::fire)                                 |
| 7  | 405  |                                                                                                                                                                                                                              |
| 8  | 500  | Trying to get property of non-object                                                                                                                                                                                         |
| 9  | 500  | Missing argument 2 for Illuminate\Database\Eloquent\Model::setAttribute(), called in /home/forge/stage.antoniocarlosribeiro.com/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php on line 2444 and defined |
+----+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

events

+----+------------------------------------------------+
| id | name                                           |
+----+------------------------------------------------+
| 1  | illuminate.log                                 |
| 2  | router.before                                  |
| 3  | router.matched                                 |
| 4  | auth.attempt                                   |
| 5  | auth.login                                     |
| 6  | composing: admin.tracker.index                 |
| 7  | creating: admin.tracker._partials.menu         |
| 8  | composing: admin.tracker._partials.menu        |
| 9  | creating: admin.layout                         |
| 10 | composing: admin.layout                        |
| 11 | creating: admin._partials.mainMenu             |
| 12 | composing: admin._partials.mainMenu            |
| 13 | creating: admin._partials.messages             |
| 14 | composing: admin._partials.messages            |
| 15 | creating: global._partials.google-analytics    |
| 16 | composing: global._partials.google-analytics   |
+----+------------------------------------------------+

geoip

+----+----------+-----------+--------------+---------------+---------------------------+--------+----------------+-------------+-----------+----------+------------+----------------+
| id | latitude | longitude | country_code | country_code3 | country_name              | region | city           | postal_code | area_code | dma_code | metro_code | continent_code |
+----+----------+-----------+--------------+---------------+---------------------------+--------+----------------+-------------+-----------+----------+------------+----------------+
| 1  | 37.4192  | -122.057  | US           | USA           | United States             | CA     | Mountain View  | 94043       | 650       | 807      | 807        | NA             |
| 2  | -10      | -55       | BR           | BRA           | Brazil                    |        |                |             |           |          |            | SA             |
| 3  | 30.3909  | -86.3161  | US           | USA           | United States             | FL     | Miramar Beach  | 32550       | 850       | 686      | 686        | NA             |
| 4  | 38.65    | -90.5334  | US           | USA           | United States             | MO     | Chesterfield   | 63017       | 314       | 609      | 609        | NA             |
| 5  | 42.7257  | -84.636   | US           | USA           | United States             | MI     | Lansing        | 48917       | 517       | 551      | 551        | NA             |
| 6  | 42.8884  | -78.8761  | US           | USA           | United States             | NY     | Buffalo        | 14202       | 716       | 514      | 514        | NA             |
| 7  | 40.1545  | -75.3809  | US           | USA           | United States             | PA     | Norristown     | 19403       | 610       | 504      | 504        | NA             |
| 8  | 47.4891  | -122.291  | US           | USA           | United States             | WA     | Seattle        | 98168       | 206       | 819      | 819        | NA             |
| 9  | 33.7516  | -84.3915  | US           | USA           | United States             | GA     | Atlanta        | 30303       | 404       | 524      | 524        | NA             |
| 10 | 33.7633  | -117.794  | US           | USA           | United States             | CA     | Santa Ana      | 92705       | 714       | 803      | 803        | NA             |
| 11 | 33.4357  | -111.917  | US           | USA           | United States             | AZ     | Tempe          | 85281       | 480       | 753      | 753        | NA             |
| 12 | 40.7421  | -74.0018  | US           | USA           | United States             | NY     | New York       | 10011       | 212       | 501      | 501        | NA             |
| 13 | 28.6185  | -81.4336  | US           | USA           | United States             | FL     | Orlando        | 32810       | 407       | 534      | 534        | NA             |
| 14 | 38.6312  | -90.1922  | US           | USA           | United States             | MO     | Saint Louis    | 63101       | 314       | 609      | 609        | NA             |
| 15 | 51       | 9         | DE           | DEU           | Germany                   |        |                |             |           |          |            | EU             |
| 16 | 52.5     | 5.75      | NL           | NLD           | Netherlands               |        |                |             |           |          |            | EU             |
| 17 | 48.86    | 2.35      | FR           | FRA           | France                    |        |                |             |           |          |            | EU             |
| 18 | 60       | 100       | RU           | RUS           | Russian Federation        |        |                |             |           |          |            | EU             |
| 19 | 51.5     | -0.13     | GB           | GBR           | United Kingdom            |        |                |             |           |          |            | EU             |
| 20 | 42.8333  | 12.8333   | IT           | ITA           | Italy                     |        |                |             |           |          |            | EU             |
| 21 | 59.3333  | 18.05     | SE           | SWE           | Sweden                    | 26     | Stockholm      |             |           |          |            | EU             |
| 22 | -41      | 174       | NZ           | NZL           | New Zealand               |        |                |             |           |          |            | OC             |
| 23 | 37.57    | 126.98    | KR           | KOR           | Korea, Republic of        |        |                |             |           |          |            | AS             |
| 24 | 1.3667   | 103.8     | SG           | SGP           | Singapore                 |        |                |             |           |          |            | AS             |
| 25 | -43.5333 | 172.633   | NZ           | NZL           | New Zealand               | E9     | Christchurch   | 8023        |           |          |            | OC             |
| 26 | -27.471  | 153.024   | AU           | AUS           | Australia                 | 04     | Brisbane       |             |           |          |            | OC             |
| 27 | 26.9167  | 75.8167   | IN           | IND           | India                     | 24     | Jaipur         |             |           |          |            | AS             |
| 28 | 32       | 53        | IR           | IRN           | Iran, Islamic Republic of |        |                |             |           |          |            | AS             |
| 29 | 32.0617  | 118.778   | CN           | CHN           | China                     | 04     | Nanjing        |             |           |          |            | AS             |
| 30 | -22.9    | -47.0833  | BR           | BRA           | Brazil                    | 27     | Campinas       |             |           |          |            | SA             |
| 31 | 32.8073  | -117.132  | US           | USA           | United States             | CA     | San Diego      | 92123       | 858       | 825      | 825        | NA             |
| 32 | -22.9    | -43.2333  | BR           | BRA           | Brazil                    | 21     | Rio De Janeiro |             |           |          |            | SA             |
+----+----------+-----------+--------------+---------------+---------------------------+--------+----------------+-------------+-----------+----------+------------+----------------+

log

+-----+------------+---------+----------+--------+---------------+---------+-----------+---------+------------+----------+
| id  | session_id | path_id | query_id | method | route_path_id | is_ajax | is_secure | is_json | wants_json | error_id |
+-----+------------+---------+----------+--------+---------------+---------+-----------+---------+------------+----------+
| 1   | 1          | 1       |          | GET    | 1             |         | 1         |         |            |          |
| 2   | 1          | 2       |          | GET    | 2             |         | 1         |         |            |          |
| 3   | 1          | 3       |          | GET    | 3             |         | 1         |         |            |          |
| 4   | 1          | 3       |          | POST   | 4             |         | 1         |         |            |          |
+-----+------------+---------+----------+--------+---------------+---------+-----------+---------+------------+----------+

paths

+----+--------------------------------------------------------+
| id | path                                                   |
+----+--------------------------------------------------------+
| 1  | /                                                      |
| 2  | admin                                                  |
| 3  | login                                                  |
| 4  | admin/languages                                        |
| 5  | admin/tracker                                          |
| 6  | admin/pages                                            |
| 7  | jmx-console                                            |
| 8  | manager/html                                           |
| 9  | administrator                                          |
| 10 | joomla/administrator                                   |
| 11 | cms/administrator                                      |
| 12 | Joomla/administrator                                   |
| 13 | phpmyadmin                                             |
| 14 | phpMyAdmin                                             |
| 15 | mysql                                                  |
| 16 | sql                                                    |
| 17 | myadmin                                                |
| 18 | webdav                                                 |
+----+--------------------------------------------------------+

route_paths

+----+----------+--------------------------------------------------------+
| id | route_id | path                                                   |
+----+----------+--------------------------------------------------------+
| 1  | 1        | /                                                      |
| 2  | 2        | admin                                                  |
| 3  | 3        | login                                                  |
| 4  | 4        | login                                                  |
| 5  | 5        | admin/languages                                        |
| 6  | 6        | admin/tracker                                          |
| 7  | 7        | admin/pages                                            |
+----+----------+--------------------------------------------------------+

routes

+----+--------------------------------------+----------------------------------------------------------+
| id | name                                 | action                                                   |
+----+--------------------------------------+----------------------------------------------------------+
| 1  | home                                 | ACR\Controllers\Home@index                               |
| 2  | admin                                | ACR\Controllers\Admin\Admin@index                        |
| 3  | login.form                           | ACR\Controllers\Logon@form                               |
| 4  | login.do                             | ACR\Controllers\Logon@login                              |
| 5  | admin.languages.index                | ACR\Controllers\Admin\Languages@index                    |
| 6  | admin.tracker.index                  | ACR\Controllers\Admin\Tracker@index                      |
| 7  | admin.pages.index                    | ACR\Controllers\Admin\Pages@index                        |
| 8  | admin.tracker.log                    | ACR\Controllers\Admin\Tracker@log                        |
| 9  | technology                           | ACR\Controllers\Technology@index                         |
| 10 | technology.articles.show             | ACR\Controllers\Technology@show                          |
| 11 | language.select                      | ACR\Controllers\Language@select                          |
| 12 | admin.tracker.summary                | ACR\Controllers\Admin\Tracker@summary                    |
| 13 | admin.tracker.api.pageviews          | ACR\Controllers\Admin\Tracker@apiPageviews               |
| 14 | admin.tracker.api.pageviewsbycountry | ACR\Controllers\Admin\Tracker@apiPageviewsByCountry      |
| 15 | admin.pages.create                   | ACR\Controllers\Admin\Pages@create                       |
| 16 | api.markdown                         | ACR\Controllers\Api@markdown                             |
| 17 | admin.pages.store                    | ACR\Controllers\Admin\Pages@store                        |
| 18 | bio                                  | ACR\Controllers\StaticPages@show                         |
| 19 | logout.do                            | ACR\Controllers\Logon@logout                             |
| 20 | admin.tracker.index                  | ACR\Controllers\Admin\UsageTracker@index                 |
| 21 | admin.tracker.api.pageviewsbycountry | ACR\Controllers\Admin\UsageTracker@apiPageviewsByCountry |
| 22 | admin.tracker.api.pageviews          | ACR\Controllers\Admin\UsageTracker@apiPageviews          |
+----+--------------------------------------+----------------------------------------------------------+

sql_queries ;

+----+------------------------------------------+-------------------------------------------------------------------------------------------------+-------+---------------+
| id | sha1                                     | statement                                                                                       | time  | connection_id |
+----+------------------------------------------+-------------------------------------------------------------------------------------------------+-------+---------------+
| 1  | 5aee121018ac16dbf26dbbe0cf35fd44a29a5d7e | select * from "users" where "id" = ? limit 1                                                    | 3.13  | 1             |
| 2  | 0fc3f3a722b0f9ef38e6bee44fc3fde9fb1fd1d9 | select "created_at" from "articles" where "published_at" is not null order by "created_at" desc | 1.99  | 1             |
+----+------------------------------------------+-------------------------------------------------------------------------------------------------+-------+---------------+

Manually log things

If your application has special needs, you can manually log things like:

Events

Tracker::trackEvent(['event' => 'cart.add']);
Tracker::trackEvent(['event' => 'cart.add', 'object' => 'App\Cart\Events\Add']);

Routes

Tracker::trackVisit(
    [
        'name' => 'my.dynamic.route.name',
        'action' => 'MyDynamic@url'
    ],
    ['path' => 'my/dynamic/url']
);

Configuration options

false, /* * Enable cache? */ 'cache_enabled' => true, /* * Deffer booting for middleware use */ 'use_middleware' => false, /* * Robots should be tracked? */ 'do_not_track_robots' => false, /* * Which environments are not trackable? */ 'do_not_track_environments' => [ // defaults to none ], /* * Which routes names are not trackable? */ 'do_not_track_routes' => [ 'tracker.stats.*', ], /* * Which route paths are not trackable? */ 'do_not_track_paths' => [ 'api/*', ], /* * The Do Not Track Ips is used to disable Tracker for some IP addresses: * * '127.0.0.1', '192.168.1.1' * * You can set ranges of IPs * '192.168.0.1-192.168.0.100' * * And use net masks * '10.0.0.0/32' * '172.17.0.0/255.255.0.0' */ 'do_not_track_ips' => [ '127.0.0.0/24', /// range 127.0.0.1 - 127.0.0.255 ], /* * When an IP is not trackable, show a message in log. */ 'log_untrackable_sessions' => true, /* * Log every single access? * * The log table can become huge if your site is popular, but... * * Log table is also responsible for storing information on: * * - Routes and controller actions accessed * - HTTP method used (GET, POST...) * - Error log * - URL queries (including values) */ 'log_enabled' => false, /* * Log artisan commands? */ 'console_log_enabled' => false, /* * Log SQL queries? * * Log must be enabled for this option to work. */ 'log_sql_queries' => false, /* * If you prefer to store Tracker data on a different database or connection, * you can set it here. * * To avoid SQL queries log recursion, create a different connection for Tracker, * point it to the same database (or not) and forbid logging of this connection in * do_not_log_sql_queries_connections. */ 'connection' => 'tracker', /* * Forbid logging of SQL queries for some connections. * * To avoid recursion, you better ignore Tracker connection here. * * Please create a separate database connection for Tracker. It can hit * the same database of your application, but the connection itself * has to have a different name, so the package can ignore its own queries * and avoid recursion. * */ 'do_not_log_sql_queries_connections' => [ 'tracker', ], /* * GeoIp2 database path. * * To get a fresh version of this file, use the command * * php artisan tracker:updategeoip * */ 'geoip_database_path' => __DIR__.'/geoip', //storage_path('geoip'), /* * Also log SQL query bindings? * * Log must be enabled for this option to work. */ 'log_sql_queries_bindings' => false, /* * Log events? */ 'log_events' => false, /* * Which events do you want to log exactly? */ 'log_only_events' => [ // defaults to logging all events ], /* * What are the names of the id columns on your system? * * 'id' is the most common, but if you have one or more different, * please add them here in your preference order. */ 'id_columns_names' => [ 'id', ], /* * Do not log events for the following patterns. * Strings accepts wildcards: * * eloquent.* * */ 'do_not_log_events' => [ 'illuminate.log', 'eloquent.*', 'router.*', 'composing: *', 'creating: *', ], /* * Do you wish to log Geo IP data? * * You will need to install the geoip package * * composer require "geoip/geoip":"~1.14" * * And remove the PHP module * * sudo apt-get purge php5-geoip * */ 'log_geoip' => false, /* * Do you wish to log the user agent? */ 'log_user_agents' => false, /* * Do you wish to log your users? */ 'log_users' => false, /* * Do you wish to log devices? */ 'log_devices' => false, /* * Do you wish to log languages? */ 'log_languages' => false, /* * Do you wish to log HTTP referers? */ 'log_referers' => false, /* * Do you wish to log url paths? */ 'log_paths' => false, /* * Do you wish to log url queries and query arguments? */ 'log_queries' => false, /* * Do you wish to log routes and route parameters? */ 'log_routes' => false, /* * Log errors and exceptions? */ 'log_exceptions' => false, /* * A cookie may be created on your visitor device, so you can have information * on everything made using that device on your site. * */ 'store_cookie_tracker' => false, /* * If you are storing cookies, you better change it to a name you of your own. */ 'tracker_cookie_name' => 'please_change_this_cookie_name', /* * Internal tracker session name. */ 'tracker_session_name' => 'tracker_session', /* * ** IMPORTANT ** * Change the user model to your own. */ 'user_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\User', /* * You can use your own model for every single table Tracker has. */ 'session_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Session', 'log_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Log', 'path_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Path', 'query_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Query', 'query_argument_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\QueryArgument', 'agent_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Agent', 'device_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Device', 'cookie_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Cookie', 'domain_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Domain', 'referer_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Referer', 'referer_search_term_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\RefererSearchTerm', 'route_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Route', 'route_path_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\RoutePath', 'route_path_parameter_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\RoutePathParameter', 'error_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Error', 'geoip_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\GeoIp', 'sql_query_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\SqlQuery', 'sql_query_binding_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\SqlQueryBinding', 'sql_query_binding_parameter_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\SqlQueryBindingParameter', 'sql_query_log_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\SqlQueryLog', 'connection_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Connection', 'event_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Event', 'event_log_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\EventLog', 'system_class_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\SystemClass', 'language_model' => 'PragmaRX\Tracker\Vendor\Laravel\Models\Language', /* * Laravel internal variables on user authentication and login. */ 'authentication_ioc_binding' => ['auth'], // defaults to 'auth' in Illuminate\Support\Facades\Auth 'authenticated_check_method' => 'check', // to Auth::check() 'authenticated_user_method' => 'user', // to Auth::user() 'authenticated_user_id_column' => 'id', // to Auth::user()->id 'authenticated_user_username_column' => 'email', // to Auth::user()->email /* * Enable the Stats Panel? */ 'stats_panel_enabled' => false, /* * Stats Panel routes before filter * */ 'stats_routes_before_filter' => '', /* * Stats Panel routes after filter * */ 'stats_routes_after_filter' => '', /* * Stats Panel routes middleware * */ 'stats_routes_middleware' => 'web', /* * Stats Panel template path */ 'stats_template_path' => '/templates/sb-admin-2', /* * Stats Panel base uri. * * If your site url is http://wwww.mysite.com, then your stats page will be: * * http://wwww.mysite.com/stats * */ 'stats_base_uri' => 'stats', /* * Stats Panel layout view */ 'stats_layout' => 'pragmarx/tracker::layout', /* * Stats Panel controllers namespace */ 'stats_controllers_namespace' => 'PragmaRX\Tracker\Vendor\Laravel\Controllers', ]; ## Requirements - Laravel 5.5+ - PHP 7.0+ - Package "geoip/geoip":"~1.14" or "geoip2/geoip2":"~2.0" (If you are planning to store Geo IP information) For Laravel < 5.5 please use version 3.0+. For Laravel 4+ please use version 2.0+. ## Compatibility table | Laravel | Tracker | |------------|---------| | 4.0 | 2.0 | | 5.0 to 5.4 | 3.0 | | 5.5 | 4.0 | ## Install Via Composer ``` bash $ composer require pragmarx/tracker ``` #### Enable the Middleware (Laravel 5) ```php 'use_middleware' => true, ``` #### Add the Middleware to Laravel Kernel (Laravel 5) Open the file `app/Http/Kernel.php` and add the following to your web middlewares: ```php \PragmaRX\Tracker\Vendor\Laravel\Middlewares\Tracker::class, ``` #### Enable Tracker in your config.php (Laravel 4) or tracker.php (Laravel 5) ```php 'enabled' => true, ``` #### Publish the migration php artisan tracker:tables This is only needed if you are on Laravel 4, because `vendor:publish` does it for you in Laravel 5. #### Create a database connection for it on your `config/database.php` ```php 'connections' => [ 'mysql' => [ ... ], 'tracker' => [ 'driver' => '...', 'host' => '...', 'database' => ..., 'strict' => false, // to avoid problems on some MySQL installs ... ], ], ``` #### Migrate it If you have set the default connection to `tracker`, you can php artisan migrate Otherwise you'll have to php artisan migrate --database=tracker #### If you are planning to store Geo IP information, also install the geoip package: composer require "geoip/geoip":"~1.14" or composer require "geoip2/geoip2":"~2.0" #### And make sure you don't have the PHP module installed. This is a Debian/Ubuntu example: sudo apt-get purge php5-geoip ## Everything Is Disabled By Default Tracker has a lot of logging options, but you need to decide what you want to log. Starting by enabling this one: ```php 'log_enabled' => true, ``` It is responsible for logging page hits and sessions, basically the client IP address. ## Multiple authentication drivers You just have to all your auth IOC bidings to the array: ```php 'authentication_ioc_binding' => ['auth', 'admin'], ``` ## Stats Panel To use the stats panel on your website you'll need to download the sb-admin 2 sources to your public folder: git clone https://github.com/BlackrockDigital/startbootstrap-sb-admin-2.git public/templates/sb-admin-2 cd public/templates/sb-admin-2 git checkout tags/v3.3.7+1 git checkout -b v3.3.7+1 And enabled in your config file: ```php 'stats_panel_enabled' => true, ``` Set the web middleware for stats routes (Laravel 5) ```php 'stats_routes_middleware' => 'web', ``` Only admins can view the stats, so if you don't have an is_admin attribute on your user model, you'll have to add one: ```php public function getIsAdminAttribute() { return true; } ``` It can be 'admin', 'is_admin', 'root' or 'is_root'. ## Troubleshooting ### SQLSTATE[42000]: Syntax error or access violation: 1067 Invalid default value for 'field name' This is probably related to SQL modes on MySQL, specifically with `NO_ZERO_IN_DATE` and `NO_ZERO_DATE` modes: https://stackoverflow.com/questions/36882149/error-1067-42000-invalid-default-value-for-created-at Because Laravel's defaults to ```sql set session sql_mode='ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION' ``` You may need to change your Tracker database connection configuration to ```php 'connections' => [ ... 'tracker' => [ ... 'strict' => false, ], ], ``` ## Author [Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro) ## License This package is licensed under the MIT License - see the `LICENSE` file for details ## Contributing Pull requests and issues are welcome.