README

Description

Action Logger records authenticated user activity for routes that opt into Enso's action-logger middleware.

It is a small backend package focused on request auditing at the application edge. It captures which authenticated user accessed which named route, by which HTTP method, at what URL, and how long the request took to complete.

The package is designed to work inside the Laravel Enso ecosystem and integrates with Enso users, permissions, dynamic relationships, frontend enums, and Enso tables.

Installation

This package comes pre-installed in Laravel Enso distributions that require activity tracking.

For standalone package installation inside an Enso-based application:

composer require laravel-enso/action-logger

The package auto-registers its service provider, loads its migrations, and registers the action-logger middleware alias.

Run the migrations after installation:

php artisan migrate

Features

Registers the action-logger route middleware alias.
Creates and maintains the action_logs table through package migrations.
Persists one log entry per authenticated request handled by the middleware.
Stores user_id, url, route, numeric method, duration, and timestamps for each action.
Exposes REST methods through the frontend-ready Methods enum.
Adds a dynamic actionLogs() relationship to the Enso User model.
Exposes an ActionLog model with user() and permission() relationships.
Links logged route names back to Enso permissions through the permission() relation.
Provides the System > Action Logs table structure, with user, method, permission, URL, duration and creation datetime columns.
Sorts the action logs table by newest entries first.
Formats request duration as a numeric column with three decimal places.
Keeps permissions as the route-facing table surface while the raw route value remains an internal storage detail.

Usage

Apply the middleware to the routes you want to track:

Route::middleware(['web', 'auth', 'action-logger'])
    ->group(function (): void {
        Route::get('/administration/users/{user}', UserController::class)
            ->name('administration.users.show');
    });

Once the middleware is active, every authenticated request matched by those routes will create a new action log entry when the request terminates.

The package also adds an actionLogs() relationship to the Enso user model, so user activity can be queried directly:

$logs = $user->actionLogs()
    ->latest()
    ->get();

API

Middleware

Alias: action-logger
Class: LaravelEnso\ActionLogger\Http\Middleware\ActionLogger
Behavior: creates the log entry in terminate(), after the response is sent

Model

LaravelEnso\ActionLogger\Models\ActionLog

Stored attributes:

user_id
url
route
method
duration
created_at
updated_at

method is cast to LaravelEnso\ActionLogger\Enums\Methods.

Relationships:

user() Belongs to LaravelEnso\Users\Models\User
permission() Belongs to LaravelEnso\Permissions\Models\Permission using route -> name

Dynamic User Relation

The package binds an actionLogs() relation to LaravelEnso\Users\Models\User through the Enso dynamic-methods package.

Enum

LaravelEnso\ActionLogger\Enums\Methods

Registered frontend key:

actionLogMethods

Supported methods:

GET
POST
PUT
PATCH
DELETE
OPTIONS
HEAD

Use Methods::fromRequest($request) to map an internal Laravel request to the stored enum value.

Table

Backend route group:

Prefix: api/system/actionLogs
Route names: system.actionLogs.*

Available endpoints:

system.actionLogs.initTable
system.actionLogs.tableData
system.actionLogs.exportExcel

The companion frontend package is @enso-ui/action-logger.

The table defaults to action_logs.created_at desc, exposes created_at as a datetime column, and displays the resolved permission instead of a separate raw route column.

::: warning Note This package only logs actions for authenticated requests. If no authenticated user is available, no action log entry is created.

Because it relies on the resolved route name, routes without meaningful names provide less useful audit data. :::

Depends On

Required Enso packages:

Framework dependency:

Laravel 12 compatible application stack

Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!

laravel-enso/actionlogger

包简介

关键字：

README 文档