LaravelPackages.net
Acme Inc.
Toggle sidebar
edwink/filament-user-activity

Tracks user activity and shows currently active users

20.292
22
2.0.1
About edwink/filament-user-activity

edwink/filament-user-activity is a Laravel package for tracks user activity and shows currently active users. It currently has 22 GitHub stars and 20.292 downloads on Packagist (latest version 2.0.1). Install it with composer require edwink/filament-user-activity. Discover more Laravel packages by edwink or browse all Laravel packages to compare alternatives.

Last updated

Tracks user activity and shows currently active users

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Filament Active Users

Registers all requests and displays it conveniently to see currently online users, ie. with any requests in the last 15 minutes / 30 minutes / 60 minutes / day / week

Installation

You can install the package via composer:

composer require edwink/filament-user-activity

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-user-activity-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-user-activity-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-user-activity-views"

This is the contents of the published config file:

return [
    "table" => [
        "name" => env("FILAMENT_USER_ACTIVITY_TABLE_NAME", "user_activities"),
        "retention-days" => env("FILAMENT_USER_ACTIVITY_RETENTION_DAYS", 60),
        'active-users' => [
            'timeframe-selection' => [
                15 => '15 Minutes',
                30 => '30 Minutes',
                60 => 'One hour',
                120 => '2 Hours',
                1440 => '24 hours',
            ],
        ],
    ]
];

Usage

Add Global Middleware in app/Http/Kernel.php in Laravel 11 and below

    /**
     * The application's global HTTP middleware stack.
     *
     * These middleware are run during every request to your application.
     *
     * @var array<int, class-string|string>
     */
    protected $middleware = [
        ...
        \Edwink\FilamentUserActivity\Http\Middleware\RecordUserActivity::class,
    ];

Add Middleware in your Filament PanelProvider in Laravel 12, default AdminPanelProvider

    public function panel(Panel $panel): Panel
    {
        return $panel
            ->default()
            ...
            ->middleware([
                \Edwink\FilamentUserActivity\Http\Middleware\RecordUserActivity::class
            ...
            ])
            ...
    }

Add trait to User Model app/Models/User.php to add relationship activities

use Edwink\FilamentUserActivity\Traits\UserActivityTrait;
...

class User extends Authenticatable
{
    use UserActivityTrait;
    ...
}

Configure your panel to have 2 additional views

use Edwink\FilamentUserActivity\FilamentUserActivityPlugin;

...
public function panel(Panel $panel): Panel
{
    return $panel
        ...
        ->plugins([
           FilamentUserActivityPlugin::make()
        ])
        ...
}
...

Configure a scheduled task to truncate table depending on your configured days (default 60 days) or run it manually from time to time.

php artisan filament-user-activity:truncate-activities-table

Access Control

To restrict access to the Resource and Page publish the config and edit the config file or add the following to your .env file:

# enable access control
FILAMENT_USER_ACTIVITY_ACCESS_CONTROL_ENABLED=true
# using Spaties - Roles & Permissions
FILAMENT_USER_ACTIVITY_SPATIE_PERMISSIONS_ACTIVE=true
FILAMENT_USER_ACTIVITY_SPATIE_PERMISSION="filament_user_activity.view" // the name of your permission default = 'filament_user_activity.view'
# alternatively restrict access only to a list of specific emails
FILAMENT_USER_ACTIVITY_ALLOWED_EMAILS="[email protected], [email protected]"
# or user_ids...
FILAMENT_USER_ACTIVITY_ALLOWED_USER_IDS="1,2,3,4"

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

Comments