Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binafy/laravel-user-monitoring
Monitor your user and all activity on your application
https://github.com/binafy/laravel-user-monitoring
laravel laravel-framework laravel-package monitoring php user-monitoring
Last synced: 6 days ago
JSON representation
Monitor your user and all activity on your application
- Host: GitHub
- URL: https://github.com/binafy/laravel-user-monitoring
- Owner: binafy
- License: mit
- Created: 2023-07-22T22:15:07.000Z (about 1 year ago)
- Default Branch: 1.x
- Last Pushed: 2024-09-21T11:19:28.000Z (12 days ago)
- Last Synced: 2024-09-25T15:22:07.724Z (8 days ago)
- Topics: laravel, laravel-framework, laravel-package, monitoring, php, user-monitoring
- Language: PHP
- Homepage: https://packagist.org/packages/binafy/laravel-user-monitoring
- Size: 341 KB
- Stars: 461
- Watchers: 10
- Forks: 35
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Laravel User Monitoring
[](https://packagist.org/packages/binafy/laravel-user-monitoring)
[](https://packagist.org/packages/binafy/laravel-user-monitoring)
[](https://packagist.org/packages/binafy/laravel-user-monitoring)
[](https://packagist.org/packages/binafy/laravel-user-monitoring)
[](https://github.com/binafy/laravel-user-monitoring/actions/workflows/tests.yml)
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Routes Configuration](#routes-configuration)
- [User Configuration](#user-configuration)
- [Foreign Key Type (UUID, ULID, ID)](#foreign-key-type-uuid-ulid-id)
- [Visit Monitoring](#visit-monitoring)
- [Delete Visit Monitoring Records By Specific Days](#delete-visit-monitoring-records-by-specific-days)
- [Turn ON-OFF](#turn-on-off)
- [Views](#visit-monitoring-views)
- [Ajax Requests](#ajax-requests)
- [Action Monitoring](#action-monitoring)
- [Views](#action-monitoring-views)
- [Authentication Monitoring](#authentication-monitoring)
- [Views](#authentication-monitoring-views)
- [How to use in big projects](#how-to-use-in-big-projects)
- [Contributors](#contributors)
- [Security](#security)
- [Changelog](#changelog)
- [License](#license)
- [Conclusion](#conclusion)
Welcome to the world of enhanced user monitoring with the groundbreaking `Laravel User Monitoring` package! Developed by the brilliant minds at `Binafy`, this innovative open-source solution is designed to empower Laravel developers and website administrators with invaluable insights into user activities.
Tracking user behavior and interactions is now made effortless, allowing you to gain a deeper understanding of your users' engagement, preferences, and pain points. With its seamless integration into Laravel projects, this package opens up a realm of possibilities, enabling you to optimize user experiences, detect bottlenecks, and make data-driven decisions for your platform's success.
Experience real-time monitoring like never before, as you access comprehensive analytics and visualize user interactions with ease. Rest assured, your users' data is handled securely, respecting privacy while giving you the tools to improve your application's performance and user satisfaction.
Whether you are building a new project or looking to enhance an existing one, "Laravel User Monitoring" is the missing piece to elevate your web applications to new heights. So, why wait? Dive into the world of intelligent user monitoring and witness the transformation of your Laravel-powered application today!
You can install the package with Composer.
```bash
composer require binafy/laravel-user-monitoring
```
## Publish
If you want to publish a config file you can use this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-config"
```
If you want to publish the migrations you can use this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-migrations"
```
If you want to publish the views you can use this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-views"
```
If you want to publish the middleware you can use this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-middlewares"
```
If you want to publish the routes you can use this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-routes"
```
For convenience, you can use this command to publish config, migration, and ... files:
```shell
php artisan vendor:publish --provider="Binafy\LaravelUserMonitoring\Providers\LaravelUserMonitoringServiceProvider"
```
After publishing, run the `php artisan migrate` command.
The `Laravel-User-Monitoring`, just need to use middleware, traits, etc ... and it's not hard, enjoys :)
If you want to customize the routes, you can publish the route file with this command:
```shell
php artisan vendor:publish --tag="laravel-user-monitoring-routes"
```
After, you can go to the `routes/user-monitoring.php` file and customize the routes.
Also, if you want to change the route file name, you can go to the config file and change the `file_path`:
```php
/*
* Configurations.
*/
'config' => [
'routes' => [
'file_path' => 'routes/user-monitoring.php',
],
],
```
You can config your user with the `user-monitoring.php` configuration file:
```php
'user' => [
/*
* User model.
*/
'model' => 'App\Models\User',
/*
* Foreign Key column name.
*/
'foreign_key' => 'user_id',
/*
* Users table name.
*/
'table' => 'users',
/*
* The correct guard.
*/
'guard' => 'web',
/*
* If you are using uuid or ulid you can change it for the type of foreign_key.
*
* When you are using ulid or uuid, you need to add related traits into the models.
*/
'foreign_key_type' => 'id', // uuid, ulid, id
],
```
- `model`: If your user model exists in another place, you can change it to the correct namespace.
- `foreign_key`: You can set the user foreign_key name, like `customer_id`.
- `table`: You can write your users table name if is not `users.
- `guard`: The correct guard that using for the user.
### Foreign Key Type (UUID, ULID, ID)
If you are using `uuid` or `ulid`, you can change `foreign_key_type` to your correct foreign key type:
```php
'user' => [
...
/*
* If you are using uuid or ulid you can change it for the type of foreign_key.
*
* When you are using ulid or uuid, you need to add related traits into the models.
*/
'foreign_key_type' => 'uuid', // uuid, ulid, id
],
```
> **_NOTE:_** You must write `uuid` or `ulid` or `id`.
When you want to monitor all views of your application, you must follow below:
1. Publish the [Migrations](#publish)
2. Use `VisitMonitoringMiddleware` in Kernel.php, you can go to the `App/Http` folder and open the `Kernel.php` file and add `VisitMonitoringMiddleware` into your middleware for example:
```php
protected $middlewareGroups = [
'web' => [
...
\Binafy\LaravelUserMonitoring\Middlewares\VisitMonitoringMiddleware::class,
],
'api' => [
// \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
\Illuminate\Routing\Middleware\ThrottleRequests::class.':api',
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
];
```
After, you can see all pages monitoring :)
If you want to disable monitoring for specific pages you can go to `user-monitoring.php` that exists in the `config` folder and add pages into the `visit_monitoring` key:
```php
'visit_monitoring' => [
/*
* You can specify pages not to be monitored.
*/
'except_pages' => [
'home',
'admin/dashboard',
],
],
```
### Delete Visit Monitoring Records By Specific Days
You may delete records by specific days, Laravel-User-Monitoring also supports this 🤩.
First, you need to go to the `user-monitoring` config file and highlight the days that you want to delete:
```php
'visit_monitoring' => [
...
/*
* If you want to delete visit rows after some days, you can change this to 360,
* but if you don't like to delete rows you can change it to 0.
*
* For this feature you need Task-Scheduling => https://laravel.com/docs/10.x/scheduling
*/
'delete_days' => 10,
],
```
After, you need to use [Task Scheduling](https://laravel.com/docs/10.x/scheduling) to fire-related command, so go to `app/Console/Kernel.php` and do like this:
```php
command(RemoveVisitMonitoringRecordsCommand::class)->hourly();
}
}
```
You can change `hourly` to `minute` or `second`, for more information you can read [Schedule Frequency Options](https://laravel.com/docs/10.x/scheduling#schedule-frequency-options).
Maybe you want to turn off visit monitoring for somedays or always, you can use configuration to turn it off:
```php
'visit_monitoring' => [
...
/*
* If you want to disable visit monitoring, you can change it to false.
*/
'turn_on' => true,
...
]
```
Laravel-User-Monitoring also has an amazing views that you can use it very easy, just need to go to `/user-monitoring/visits-monitoring` url, and enjoy:
Maybe you may disable record visits for `Ajax` requests, you can use config to disable it:
```php
'visit_monitoring' => [
...
/*
* If you want to disable visit monitoring in Ajax mode, set it to false.
*/
'ajax_requests' => true,
...
],
```
When set to false, Ajax requests will not be recorded.
If you want to monitor your models actions, you can use the `Actionable` trait in your model:
```php
[
...
/*
* Monitor actions.
*
* You can set true/false for monitor actions like (store, update, and ...).
*/
'on_store' => false,
'on_update' => true,
'on_destroy' => true,
'on_read' => true,
'on_restore' => false,
'on_replicate' => false,
],
```
`Laravel-User-Monitoring` also has amazing views that you can use very easily, just need to go to the `/user-monitoring/actions-monitoring` URL, and enjoy:
Have you ever thought about monitoring the entry and exit of users of your application? Now you can :)
If you want to monitor users when logging in or logout of your application, you need to migrate the migrations to the config file and change true for monitoring authentication.
```php
'authentication_monitoring' => [
...
/*
* You can set true/false for monitor login or logout.
*/
'on_login' => true,
'on_logout' => true,
],
```
### Authentication Monitoring Views
`Laravel-User-Monitoring` also has amazing views that you can use very easily, just need to go to the `/user-monitoring/authentications-monitoring` URL, and enjoy:
If you want to use `Laravel-User-Monitoring` is big projects, you have lots of ways, but I want to give some tips and ideas to help you:
> If you have an idea for this section you can create [PRs](https://github.com/binafy/laravel-user-monitoring/pulls) or [issues](https://github.com/binafy/laravel-user-monitoring/issues) to help us.
1. You can use this package with [Cache](https://laravel.com/docs/10.x/cache)
2. You can make a separate DB and connect to your project to separate monitoring and application.
Thanks to all the people who contributed. [Contributors](https://github.com/binafy/laravel-user-monitoring/graphs/contributors).
If you discover any security-related issues, please email `[email protected]` instead of using the issue tracker.
The changelog can be found in the `CHANGELOG.md` file of the GitHub repository. It lists the changes, bug fixes, and improvements made to each version of the Laravel User Monitoring package.
The MIT License (MIT). Please see [License File](https://github.com/binafy/laravel-user-monitoring/blob/1.x/LICENSE) for more information.
Congratulations! You have successfully installed and integrated the Laravel User Monitoring package into your Laravel application. By effectively logging and analyzing user activity, you can gain valuable insights that can help you improve your application's user experience and performance. If you have any questions or need further assistance, please refer to the documentation or seek help from the package's GitHub repository. Happy monitoring!