What it is
Laravel Auditing is a PHP package for the Laravel ecosystem that records the change log from Eloquent models. Its topic list also identifies Lumen as a relevant environment. The package is MIT licensed, and its active 14.x line supports Illuminate 11.x.x through 13.x.x on PHP 8.2 or later.
The concrete problem it solves is the lack of a simple, built-in way to understand how model data changed over time. By keeping a history of model changes through a trait, the package can expose information about possible discrepancies and anomalies that could indicate business concerns or suspect activities. This makes it useful for compliance and risk management inside Laravel applications.
Key capabilities
- Records changes to Eloquent models by adding an auditing trait to the model.
- Maintains a history of model revisions so past changes can be reviewed rather than inferred from current data.
- Provides information about discrepancies and anomalies that may indicate business concerns or suspect activities.
- Supports retrieval of audited data in a straightforward way, allowing the history to be displayed in various application views.
- Targets the Laravel ecosystem and includes Lumen in its topic list, indicating use in Laravel-family PHP applications.
- Aligns with active Illuminate versions 11.x.x through 13.x.x on PHP 8.2 or later for the current 14.x release line.
Who uses it and how
- Laravel application teams use it when they need a change log for Eloquent models.
- Compliance and risk management teams use the recorded history to review discrepancies or anomalies that may require investigation.
- Developers attach the auditing trait to selected models and then retrieve the stored change records for display in admin panels, reports, or other interfaces.
- Projects that track revisions can compare historical model states across time, using the package’s logging and tracking capabilities.
- Teams maintaining older Laravel or Lumen applications can consult the version table to determine whether their Illuminate and PHP versions match an active or end-of-life support line.
Getting started
The README directs users to the official documentation at laravel-auditing.com or the repository documentation file for detailed installation and usage instructions. The active 14.x release line supports Illuminate 11.x.x through 13.x.x and requires PHP 8.2 or later.
When to use it — and when not to
Use it when a Laravel or Lumen application needs model-level change history inside the application itself, especially where compliance or risk review depends on seeing discrepancies and suspect activity. Do not choose it when a project needs a paid product replacement, because the README does not list any paid product it replaces. Also, the README does not mention a Docker image, hosted option, or required external services such as database, storage, or SMTP, so teams must plan their own deployment and data-handling details outside the package description.
project readme (upstream, from github) — read inline
This package will help you understand changes in your Eloquent models, by providing information about possible discrepancies and anomalies that could indicate business concerns or suspect activities.
Laravel Auditing allows you to keep a history of model changes by simply using a trait. Retrieving the audited data is straightforward, making it possible to display it in various ways.
Official Documentation
For more information on how to use the package, please refer to our official documentation available on laravel-auditing.com or in the repository documentation file. Our documentation provides detailed instructions on how to install and use the package, as well as examples and best practices for auditing in Laravel applications.
Thank you for choosing OwenIt\LaravelAuditing!
Version Information
Contributing
Please see the contributing entry for more details.
Credits
Special thanks for keeping this project active.
License
The Laravel Auditing package is open source software licensed under the MIT LICENSE.