Every time we talk about auditing information in software, we ask ourselves what is the best way to do it and how to make sure nothing is missed.
With this in mind, this audit package was created, which uses the database trigger's structure to perform the audit. This allows us to identify all changes that have occurred, whether through a system or directly through the database manager.
After installing the package, records will be saved in the 'audits' table.
The data "before" and "after" the actions performed by the user will always be stored.
A "context" is stored, containing information about the origin and user responsible for the action that occurred.
You can see an example of an audit record below:
array:8 [
"id" => 2
"schema" => "public"
"table" => "users"
"event" => "INSERT"
"context" => array:4 [
"ip" => "127.0.0.1"
"origin" => "http://localhost"
"user_id" => 1
"user_name" => "Tracy Nienow MD"
]
"before" => null
"after" => array:5 [
"id" => 2
"name" => "Hildegard Strosin Jr."
"email" => "qschoen@example.org"
"created_at" => "2024-09-16T20:59:20"
"updated_at" => "2024-09-16T20:59:20"
]
"date" => "2024-09-16 17:59:21"
]You can install the package via composer:
composer require edineivaldameri/auditAfter executing the command:
php artisan audit:installOnce the installation is complete, the package will automatically identify the creation of new tables and add auditing without the need for a new installation.
Once installed, you can configure the package configuration file using the command:
php artisan vendor:publish --provider="EdineiValdameri\Laravel\Audit\Providers\AuditServiceProvider" --tag='config'With this, a file called audit.php will be available in the settings directory, in which you can enable/disable auditing, as well as insert tables that you do not want to audit.
If you want to temporarily disable audits, just insert in your .env: AUDIT_ENABLED=false.
When installing and publishing the configuration file, you can insert tables that you want to ignore when performing the audit, just insert their names in the skip property.
But remember you can only ignore these tables before running the php artisan audit:install command.
To uninstall to run the command:
php artisan audit:uninstallThis package has been tested and works well with PostgreSql databases, new databases are being tested and may have their support added over time.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.