Laravel ActivityLog 使用教程

项目介绍

laravel-activitylog 是一个为 Laravel 框架设计的开源日志记录包，由 Spatie 团队开发和维护。该包允许开发者轻松记录用户操作、模型变化等事件，非常适合用于审计跟踪和监控系统活动。

项目快速启动

安装

首先，通过 Composer 安装 laravel-activitylog：

composer require spatie/laravel-activitylog

配置

发布配置文件：

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-config"

运行迁移以创建活动日志表：

php artisan migrate

基本使用

在模型中使用 CausesActivity 和 LogsActivity 特性：

use Spatie\Activitylog\Traits\LogsActivity;
use Spatie\Activitylog\Traits\CausesActivity;

class User extends Authenticatable
{
    use LogsActivity;
    use CausesActivity;

    protected $fillable = [
        'name', 'email', 'password',
    ];

    protected static $logAttributes = ['name', 'email'];
    protected static $logOnlyDirty = true;
}

记录活动：

$user = User::find(1);
$user->name = 'New Name';
$user->save();

查看日志：

use Spatie\Activitylog\Models\Activity;

$activities = Activity::all();

应用案例和最佳实践

审计跟踪

在用户管理或内容管理系统中，使用 laravel-activitylog 记录用户的关键操作，如登录、修改密码、创建或删除内容等，以便进行审计跟踪。

监控系统活动

在电子商务平台或金融系统中，记录用户的交易行为、账户变动等，以便监控系统活动，及时发现异常行为。

典型生态项目

Laravel Telescope

Laravel Telescope 是一个 Laravel 应用程序的调试助手，可以与 laravel-activitylog 结合使用，提供更详细的日志和调试信息。

Laravel Horizon

Laravel Horizon 是一个用于管理 Laravel Redis 队列的漂亮仪表板和代码驱动的配置系统，可以记录队列任务的执行情况，与 laravel-activitylog 结合使用，可以更好地监控和管理队列任务。

通过以上步骤和案例，您可以快速上手并充分利用 laravel-activitylog 的功能，提升您的 Laravel 应用程序的日志记录和监控能力。