README

Activity Tracker Package

A comprehensive activity tracking package for Laravel applications that logs various types of activities including authentication events, model changes, exceptions, route access, and database queries.

Features

• 🔐 Authentication Tracking: Login, logout, failed attempts, lockouts, registrations, email verifications, and password resets
• 📝 Model Changes: Create, update, delete, force delete, and restore operations
• ⚠️ Exception Logging: Various HTTP and system exceptions
• 🛣️ Route Access: Track accessed routes with request details
• 🔍 Query Logging: Monitor database queries with execution time
• 📱 Device Information: Browser, operating system, and device type detection
• 🔄 Flexible Storage: Store logs in database or files
• ⚙️ Highly Configurable: Extensive configuration options for each feature

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Installation

You can install the package via composer:

composer require abdulbaset/activity-tracker

Configuration

Publish the configuration file:

php artisan vendor:publish --provider="Abdulbaset\ActivityTracker\Providers\ActivityTrackerServiceProvider"

This will create a config/activity-tracker.php file where you can configure various aspects of the package.

Migrations

After installing the package, you need to run the migrations to create the required database tables. To do this, use the following Artisan command:

php artisan migrate --path=vendor/abdulbaset/activity-tracker/src/database/migrations

Basic Usage

Manual Logging

use ActivityTracker;

// Simple activity logging
ActivityTracker::log('User Profile', 'User updated their profile');

// Detailed activity logging
ActivityTracker::log(
    'Order Created',
    'New order #123 was created',
    [
        'properties' => [
            'order_id' => 123,
            'amount' => 99.99
        ]
    ]
);

Model Tracking

Add the Trackable trait to your model:

use Abdulbaset\ActivityTracker\Traits\Trackable;

class User extends Model
{
    use Trackable;
}

Configuration Options

General Configuration

return [
    'enabled' => env('ACTIVITY_TRACKER_ENABLED', true),
    'log_method' => env('ACTIVITY_TRACKER_LOG_METHOD', 'database'), // 'database' or 'file'
    'log_file_path' => storage_path('logs/activity_tracker.log'),
];

Authentication Events

'auth' => [
    'enabled' => true,
    'events' => [
        'login' => true,
        'logout' => true,
        'failed' => true,
        'lockout' => true,
        'registered' => true,
        'verified' => true,
        'password_reset' => true,
    ],
],

Model Events

'models' => [
    'enabled' => true,
    'events' => [
        'creating' => true,
        'created' => true,
        'updating' => true,
        'updated' => true,
        'deleting' => true,
        'deleted' => true,
        'force_deleting' => true,
        'force_deleted' => true,
        'restoring' => true,
        'restored' => true,
    ],
    'full_model_data' => false,
],

Exception Tracking

'exceptions' => [
    'enabled' => true,
    'events' => [
        'not_found' => true,
        'unauthorized' => true,
        'method_not_allowed' => true,
        'too_many_requests' => true,
        'conflict' => true,
        'unprocessable_entity' => true,
        'access_denied' => true,
        'gone' => true,
        'precondition_failed' => true,
        'unsupported_media_type' => true,
        'general' => true,
    ],
    'include_trace' => false,
],

Exclusions

'exclude' => [
    'routes' => [
        'horizon*',
        'nova*',
        '_debugbar*',
    ],
    'models' => [],
    'model_attributes' => [
        'password',
        'remember_token',
        'api_token',
        // ... other sensitive fields
    ],
],

Database Schema

The package creates an activities table with the following structure:

API Resource

The package includes an API resource for formatting activity logs:

use Abdulbaset\ActivityTracker\Resources\ActivityTrackerResource;

// In your controller
public function index()
{
    $activities = ActivityTracker::latest()->paginate();
    return ActivityTrackerResource::collection($activities);
}

Events

The package tracks the following events:

Authentication Events

• Login
• Logout
• Failed Login
• Lockout
• Registration
• Email Verification
• Password Reset

Model Events

• Creating/Created
• Updating/Updated
• Deleting/Deleted
• Force Deleting/Force Deleted
• Restoring/Restored

Exception Events

• Not Found
• Unauthorized
• Method Not Allowed
• Too Many Requests
• Conflict
• Unprocessable Entity
• Access Denied
• Gone
• Precondition Failed
• Unsupported Media Type
• General Exceptions

Security

If you discover any security-related issues, please email AbdulbasetRedaSayedHF@Gmail.com instead of using the issue tracker.

Credits

• Abdulbaset R. Sayed

License

The MIT License (MIT). Please see License File for more information.

Support

For support:

• Email: AbdulbasetRedaSayedHF@Gmail.com
• Create an issue in the GitHub repository

Donations 💖

Maintaining this package takes time and effort. If you’d like to support its development and keep it growing, you can:

• 🌟 Star this repository
• 📢 Sharing it with others
• 🛠️ Contribute by reporting issues or suggesting features
• ☕ Buy me a coffee
• ❤️ Become a sponsor on GitHub Sponsors
• 💵 Make a one-time donation via PayPal

Your support means a lot to me! Thank you for making this possible. 🙏