Audit Migration #

While the package comes with a pretty standard migration file which covers most use cases, the default table schema might not be suitable for everyone.

With that in mind, here are a few tweaks that can be performed.

Using a different column name for the User ID/Type #

Instead of the typical user_id column, a different name can be used:

$table->nullableMorphs('owner');

Just make sure the morph_prefix value in the configuration is also updated, to reflect the change:

return [
    'user' = [
        'morph_prefix' => 'owner',
    ],
];

UUID over auto-incrementing ids #

Some developers prefer to use a UUID instead of auto-incrementing ids. If that's the case, make sure to update the up() method like so:

For the User, change from

$table->nullableMorphs('user');

to

$table->string('user_type')->nullable();
$table->uuid('user_id')->nullable();
$table->index([
    'user_type',
    'user_id', 
]);

For the Auditable model, change from

$table->morphs('auditable');

to

$table->string('auditable_type');
$table->uuid('auditable_id');
$table->index([
    'auditable_type',
    'auditable_id', 
]);

Values with more than 255 characters #

Sometimes, the URL, Tags or User Agent values may be longer than 255 characters, so the corresponding columns should be updated from string

$table->string('url')->nullable();
$table->string('user_agent')->nullable();
$table->string('tags')->nullable();

to text

$table->text('url')->nullable();
$table->text('user_agent')->nullable();
$table->text('tags')->nullable();

JSON WHERE() clauses #

Given the Query Builder supports querying JSON columns, the old_values and new_values column types can be updated from text

$table->text('old_values')->nullable();
$table->text('new_values')->nullable();

to json

$table->json('old_values')->nullable();
$table->json('new_values')->nullable();

This will provide an additional way to filter Audit data.