Download the PHP package rovereto/metrika without Composer

On this page you can find all versions of the php package rovereto/metrika. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package metrika

Laravel Metrika

This is a reworked copy of Rinvex Statistics that was abandoned. Also inspired by the Laravel Stats Tracker

Main differences

Packagist License Packagist Downloads

Description Rinvex Statistics

Rinvex Statistics is a lightweight, yet detailed package for tracking and recording user visits across your Laravel application. With only one simple query per request, important data is being stored, and later a cronjob crush numbers to extract meaningful stories from within the haystack.

Unlike other tracking packages that seriously damage your project's performance (yes, I mean that package you know 😅), our package takes a different approach by just executing only one query at the end of each request after the response is being served to the user, through the terminate method of an automatically attached middleware, and then later on it uses the raw data previously inserted in the database to extract meaningfull numbers. This is done based on a random lottery request, or through a scheduled job (recommended) that could be queued to offload the heavy crunching work.

Rinvex Statistics tracks each -valid- request, meaning only requests that goes through routing pipeline, which also means that any wrong URL that results in NotFoundHttpException will not be tracked. If requested page has uncaught exceptions, it won't be tracked as well. It track user's logged in account (if any), session of all users and guests (if any), device (family, model, brand), platform (family, version), browser (agent, kind, family, version), path, route ( action, middleware, parameters), host, protocol, ip address, language, status codes, and many more, and still we've plenty of awesome features planned for the future.

With such a huge collected data, the statistics_requests database table will noticeably increase in size specially if you've a lot of visits, that's why it's recommended to clean it periodically. Other important data will stay still in their respective tables, normalized and without any performance issues, so only this table need to be cleaned. By default that will be done automatically every month.

The default implementation of Rinvex Statistics comes with zero configuration out-of-the-box, which means it just works once installed. But it's recommended to change the defaults and disable the "Statistics Crunching Lottery" from config file, and replace it with a Scheduled Tasks for even better performance if you've large number of visits. See Usage for details.

Installation

  1. Install the package via composer:

  2. Publish resources (migrations and config files):

  3. If you need to save statistics to another database, edit config/metrika.php

    And create a database connection for it on your config/database.php

  4. Execute migrations via the following command:

  5. Done!

Usage

Laravel Metrika like Rinvex Statistics has no usage instructions, because it just works! You install it and you are done! Seriously!!

Anyway, as a recommended performance tweak go ahead and do the following (optionally):

  1. Publish config file via the following command:

  2. Disable the "Statistics Crunching Lottery" from config file.

  3. Follow the default Laravel documentation about Scheduled Tasks, then schedule both \Rovereto\Metrika\Jobs\CrunchStatistics and \Rovereto\Metrika\Jobs\CleanStatisticsRequests jobs at whatever intervals you see appropriate.

  4. Enjoy!

Note: Laravel Metrika has a \Rovereto\Metrika\Http\Middleware\TrackStatistics middleware that attach itself automatically to the web middleware group, that's how it works out-of-the-box with zero configuration.

Data retrieval

You may need to build your own frontend interface to browse statistics, and for that you can utilize any of the included eloquent models as you normally do with Laravel Eloquent.

All eloquent models are self explainatory:

All models are bound to the Service Container so you can swap easily from anywhere in your application. In addition to the default normal way of using these models explicitely, you can use their respective service names as in the following example:

Same for all other eloquent models.

Identify Geographical Location

To determine the geographic location by ip address, the GeoIP for Laravel (Torann\GeoIP) package is used.

To customize the package, publish the configuration file:

A configuration file will be publish to config/geoip.php.

An example of using MaxMindDatabase:

The Torann\GeoIP package does not support IP2Location, but they have implemented support for this base.

An example of using IP2Location:

Identify Proxy

To determine the proxy by ip address, the IP2Proxy PHP Module package is used.

Detection the proxy are disabled by default. Enable them in the config file config/metrika.php, also write the filename of the bin database.

An example of using determine the proxy:

Using cookie files

Metrika may use anonymous identifiers to keep track of visitors, which are stored in a cookie. Cookies are disabled by default. Enable them in the config file config/metrika.php, also give the cookie a name. An example:

And set the first level domain for the cookie in the file .env:

or file config/session.php:

If you are using multiple subdomains, to identify the same user, disable cookie encryption for the Metrika in the file app/Http/Middleware/EncryptCookies.php:

Notes: Each Laravel application encrypts cookies with its own key. Therefore, the cookies of one caller will be encrypted in different ways.

Data usage

Two class connection options Laravel Metrika

or

Most viewed pages for the selected period, count - $limit

Graph number of: hits, visits, unique visitors by day

Return an array for plotting a line graph

Methods for building pie charts

Graph pie source by period
Graph pie search system by period
Graph pie browsers by period
Graph pie operating systems by period
Graph pie devices by period
Graph pie countries and regions by period

An example of usage is in the directory examples

Counts that matters

All agent, device, path, platform, route models have a count attribute, which gets updated automatically whenever a new request has been tracked.

This count attribute reflects number of hits. To make it clear let's explain through data samples:

Agents

id name kind family version count
1 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36 desktop Chrome 63.0.3239 734

This means there's 734 visit to our project through Chrome browser, version 63.0.3239, with agent ( Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36)

Devices

id family model brand count
1 iPhone iPhone Apple 83

This means there's 83 visits to our project through iPhone device.

Platforms

id family version count
1 Mac OS X 10.12.6 615

This means there's 615 visits to our project through Mac OS X operating system, with version 10.12.6.

Paths

id host locale path count
1 test.homestead.local en en/adminarea/roles/admin 12

This means there's 12 visits to the admin dashboard roles management of the test.homestead.local host (in case you have multiple hosts or wildcard subdomains enabled on the same project, you can track all of them correctly here). The english interface was used, one for locale (english in this case), and updated role record (admin in this case).

This table could be used as a visit counter for all your pages. To retrieve and display page views you can use the following code for example:

And simply use the $pageViews variable anywhere in your views or controllers, or anywhere else. That way you have automatic visit counter for all your project's pages, very useful and performant, ready at your fingertips. You can add host contraint in case you have wildcard subdomains enabled.

Queries

id query
1 {"name":"Mike","city":"New York"}

Request parameters as json

Routes

id name path action middleware parameters count
1 adminarea.roles.edit {locale}/adminarea/roles/{role} App\Http\Controllers\Adminarea\RolesController@form ["web","nohttpcache","can:access-adminarea","auth","can:update-roles,roles"] {"role": "[a-z0-9-]+", "locale": "[a-z]{2}"} 41

This means there's 41 visits to the adminarea.roles.edit route, which has the {locale}/adminarea/roles/{role} raw path, and served through the App\Http\Controllers\Adminarea\RolesController@form controller action, and has the following middleware applied ["web","nohttpcache","can:access-adminarea","auth","can:update-roles,roles"], knowing the route accepts two parameters with the following regex requirements {"role": "[a-z0-9-]+", "locale": "[a-z]{2}"}.

As you can see, this statistics_routes table beside the statistics_paths table are both complimentary, and could be used together to track which paths and routs are being accessed, how many times, and what controller actions serve it, and what parameters are required, with the actual parameter replacements used to access it. Think of routes as your raw links blueprint map, and of paths as the executed and actually used links by users.

Referers

id domain_id url medium source count
1 3 https://www.facebook.com/ social Facebook 57

This means there's 57 visits to our project from the social facebook.com.

Medium field options:

Domains

id name count
1 google.com 24

This means there's 24 visits to our project from google.com.

Geoips

id client_ip latitude longitude country_code client_ips is_from_trusted_proxy division_code postal_code timezone city count
1 127.0.0.0 41.31 -72.92 US NULL 0 CT 06510 America/New_York New Haven 57

This means there's 57 visits to the project from IP address 127.0.0.0 with the latitude, longitude and timezone mentioned above coming from New Haven city, Connecticut state.

Visitors

id user_type user_id cookie_id agent_id device_id platform_id language is_robot count created_at
1 user 123 ttivveoa18qc471vv9qfbg6qr1 123 123 123 en_US 0 55 2022-05-07 09:42:39

Unique visitors. Through session_id, user_id and user_type you can track guests (logged out) and users (logged in).

Visits

id visitor_id user_type user_id session_id geoip_id referer_id count created_at
1 123 user 123 5lajaqs5g4em8vqaoub4hbicf0 123 123 2 2022-05-07 09:42:39

Unique visits. Through session_id, user_id and user_type you can track guests (logged out) and users (logged in).

Hits

id visitor_id visit_id route_id path_id query_id referer_id status_code method protocol_version is_no_cache wants_json is_secure is_json is_ajax is_pjax created_at
1 123 123 123 123 123 123 200 GET/POST HTTP/1.1 0 0 1 0 0 0 2022-05-07 09:42:39

This is the most comprehensive table that records every single request made to the project, with access details as seen in the sample above.

Notes:

  • As a final note, this package is a data hord, and it doesn't actually do much of the math that could be done on such a valuable gathered data, so it's up to your imagination to utilize it however you see fits your goals. Implementation details is up to you.
  • We didn't explain the data table since it's used for temporary raw data storage until it's being crunched and processed by the package, so you should NOT care or mess with that table. It's used internally by the package and has no real end-user usage.
  • The \Rovereto\Metrika\Models\Hit model has relationships to all related data such as visitor, visit, agent, device, platform, path, route, referer, domain and geoip. So once you grab a hit instance you can access any of it's relationships as you normaly do with Eloquent Relationships like so: $hit->visitor->agent->version, $hit->visitor->platform->family or $hit->visit->geoip->city.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Changelog

Refer to the Changelog for a full history of the project.

Support

The following support channels are available at your fingertips:

Author

See also the list of contributors who participated in this project.

License

This project is licensed under the The MIT License (MIT) Massachusetts Institute of Technology License - see the LICENSE.md file for details


All versions of metrika with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0.0
doctrine/dbal Version ^2.5 || ^3.0
geoip2/geoip2 Version ^2.0.0
illuminate/bus Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/console Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/contracts Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/database Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/http Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/queue Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/routing Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
illuminate/support Version ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0
ip2location/ip2location-php Version ^9.0.0
ip2location/ip2proxy-php Version ^4.0.0
jaybizzle/crawler-detect Version ~1.0
jenssegers/agent Version ^2.6.0
rovereto/country Version ^1.0
snowplow/referer-parser Version ~0.1
symfony/http-foundation Version ^6.0|^7.0
torann/geoip Version ^3.0.0
ua-parser/uap-php Version ^3.9.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rovereto/metrika contains the following files

Loading the files please wait ....