Laravel Analytics

First-party, self-hosted application analytics for Laravel.

Track page views, unique visitors, HTTP errors, and optional IP bans from your own database. An optional Livewire 4 dashboard provides KPIs, trends, and management screens when you explicitly enable it.

Status

Pre-release development. Core analytics features (traffic, visitors, errors, IP banning, retention pruning, and an optional dashboard) are implemented in this repository. No stable Packagist release has been tagged yet.

Requirements

• PHP 8.3+
• Laravel 12 or 13

These match the composer.json constraints. CI tests PHP 8.3–8.5 against Laravel 12 and 13 on Ubuntu and Windows.

Installation

composer require simba-jirira-source/laravel-analytics

The service provider is registered automatically via Laravel package discovery.

Publish configuration

php artisan vendor:publish --tag=analytics-config

Publish and run migrations

Migrations are not loaded automatically. Publish them, then migrate:

php artisan vendor:publish --tag=analytics-migrations
php artisan migrate

Publish everything (optional)

The shared analytics tag publishes config, views, translations, assets, and migrations:

php artisan vendor:publish --tag=analytics
php artisan migrate

Individual publish tags:

See docs/INSTALLATION.md for a full setup walkthrough.

Quick start

After publishing config and running migrations, enable features explicitly in config/analytics.php:

'enabled' => true,

'tracking' => [
    'traffic' => true,
    'errors' => true,
],

'ip_banning' => [
    'enabled' => false, // opt-in; disabled by default
],

'dashboard' => [
    'enabled' => true,
    'authorization' => 'viewAnalyticsDashboard',
    'middleware' => ['web', 'auth'],
],

When enabled is true and tracking toggles are on, the package registers middleware on the web group automatically. You do not need to add middleware aliases manually for the default setup.

Define authorization for the dashboard in your application, for example:

use Illuminate\Support\Facades\Gate;

Gate::define('viewAnalyticsDashboard', fn ($user) => /* your policy */);

Visit /analytics (or your configured dashboard.path) when the dashboard is enabled and authorized.

Features

Artisan commands

Pruning is not scheduled automatically. See docs/RETENTION.md.

There is no analytics:install command; follow docs/INSTALLATION.md instead.

Privacy defaults

By default the package:

• does not enable tracking, banning, or the dashboard;
• does not store raw IP addresses;
• hashes visitor identifiers using application-specific salt;
• does not associate authenticated users unless configured;
• excludes dashboard routes from self-tracking.

See docs/PRIVACY.md for full details.

This package provides technical privacy controls but does not itself make an application compliant with any specific privacy law or regulatory framework.

Configuration overview

All settings live in config/analytics.php. See docs/CONFIGURATION.md for every key.

Extension points (contracts):

• LaravelAnalytics\LaravelAnalytics\Contracts\VisitorIdentifier
• LaravelAnalytics\LaravelAnalytics\Contracts\AnalyticsRecorder
• LaravelAnalytics\LaravelAnalytics\Contracts\ErrorRecorder

Testing

composer install
composer verify

Individual gates:

composer test          # prepare, PHPStan, Pint, type coverage, Pest
composer analyse       # PHPStan (level 7)
composer lint:check    # Pint
composer test:unit     # Pest

Static analysis

PHPStan level 7 via Larastan. Run composer run prepare before composer analyse when analysing locally (the composer test script does this automatically).

Code of conduct

See CODE_OF_CONDUCT.md.

Contributing

Please read CONTRIBUTING.md before opening a pull request.

Security

Report security issues privately. See SECURITY.md.

Versioning

This project follows Semantic Versioning. APIs may change before 1.0.0. See CHANGELOG.md.

License

The MIT License. See LICENSE.md.

Credits

• simba-jirira-source