PHP

Laravel Audit Logging Guide

Add tamper-proof audit logging to your Laravel application with the AuditKit PHP SDK. Eloquent model observers, middleware, and event system integration.

Overview

Laravel is the most popular PHP framework for building modern web applications. The AuditKit Laravel package provides Eloquent model observers for automatic change tracking, HTTP middleware for request logging, and integration with Laravel's event system. The package follows Laravel conventions with a service provider, publishable configuration, and Artisan commands.

Getting started

1

Install the package

Add AuditKit via Composer.

PHP
composer require auditkit/laravel
php artisan vendor:publish --provider="AuditKit\Laravel\AuditKitServiceProvider"
2

Configure environment

Add your API key to .env.

PHP
# .env
AUDITKIT_API_KEY=your_api_key_here

# config/auditkit.php is auto-published
# Configure tenant resolution, async mode, etc.
3

Add the Auditable trait to models

Use the trait for automatic Eloquent change tracking.

PHP
use AuditKit\Laravel\Traits\Auditable;

class Document extends Model
{
    use Auditable;

    protected $auditFields = ['title', 'status', 'classification'];
    protected $auditEvents = ['created', 'updated', 'deleted'];
}
4

Log explicit events

Use the AuditKit facade for custom events.

PHP
use AuditKit\Laravel\Facades\AuditKit;

class DocumentController extends Controller
{
    public function approve(Document $document)
    {
        $document->update(['status' => 'approved']);

        AuditKit::log([
            'action' => 'document.approved',
            'actor' => ['id' => auth()->id(), 'email' => auth()->user()->email],
            'target' => ['type' => 'document', 'id' => $document->id],
            'metadata' => ['title' => $document->title],
        ]);
    }
}

Complete example

Here is a complete example showing AuditKit integrated into a Laravel application with authentication logging, data access tracking, and explicit event capture.

PHP
// config/auditkit.php
return [
    'api_key' => env('AUDITKIT_API_KEY'),
    'tenant_resolver' => fn ($request) => $request->user()?->organization_id,
    'async' => true,  // Use Laravel queues for delivery
    'queue' => 'audit',
];

// app/Models/Invoice.php
use AuditKit\Laravel\Traits\Auditable;

class Invoice extends Model
{
    use Auditable;

    protected $auditFields = ['amount', 'status', 'due_date'];

    public function customer()
    {
        return $this->belongsTo(Customer::class);
    }
}

// app/Http/Controllers/InvoiceController.php
use AuditKit\Laravel\Facades\AuditKit;

class InvoiceController extends Controller
{
    public function refund(Invoice $invoice)
    {
        $previousStatus = $invoice->status;
        $invoice->update(['status' => 'refunded']);

        AuditKit::log([
            'action' => 'invoice.refunded',
            'actor' => [
                'id' => (string) auth()->id(),
                'email' => auth()->user()->email,
            ],
            'target' => ['type' => 'invoice', 'id' => (string) $invoice->id],
            'metadata' => [
                'invoice_number' => $invoice->number,
                'amount' => $invoice->amount,
                'previous_status' => $previousStatus,
            ],
        ]);

        return response()->json($invoice);
    }
}

Common patterns

Auditable trait for Eloquent model change tracking

HTTP middleware for automatic request logging

Laravel event/listener integration

Queue-based async event delivery

Laravel Sanctum/Passport auth event capture

Nova admin action logging

Frequently asked questions

How do I add audit logging to a Laravel application?

Install auditkit/laravel via Composer, publish the config, and add your API key. Use the Auditable trait on Eloquent models for automatic change tracking, or use the AuditKit facade for explicit event logging.

Does AuditKit support Laravel queues?

Yes. Set async to true in config/auditkit.php and AuditKit will dispatch events to your configured queue. This keeps your request handling fast while ensuring reliable delivery through Laravel's queue system.

More integration guides

Node.js Audit Logging

TypeScript / JavaScript

NestJS Audit Logging

TypeScript

FastAPI Audit Logging

Python

Go Audit Logging

Go

Django Audit Logging

Python

Ruby on Rails Audit Logging

Ruby

Related resources

SOC 2 Audit Logging Requirements

Understand what SOC 2 requires for audit logging and how AuditKit satisfies each control.

All Compliance Frameworks

SOC 2, ISO 27001, HIPAA, GDPR, FedRAMP, and more.

Add audit logging to your Laravel app

Get started with tamper-proof audit trails in minutes. Open source, from $99/mo.

Start Free TrialRead the Docs