Audit & Compliance Logging

Append-only immutable event streams for compliance and forensic analysis.

The Audit module creates a permanent, queryable history of state mutations across all domain entities. It guarantees non-repudiation while supporting high-throughput ingestion via background queues without degrading web request latencies.

Capabilities

Core Functional Capabilities

✓ Automatic Eloquent model mutation tracking (before/after diffs)

✓ Contextual metadata enrichment (IP, User Agent, Tenant ID, Request ID)

✓ Asynchronous high-throughput queue ingestion to avoid request lag

✓ Cryptographic record hashing for tamper verification

✓ Structured query builder for compliance exports and investigation

✓ Configurable retention rules and automated cold storage archiving

Contracts

Public Interface Contracts

Other modules and domain action classes interact exclusively via these typed PHP contracts.

interface AuditLoggerInterface

interface AuditRecordRepositoryInterface

interface DiffGeneratorInterface

interface AuditExporterInterface

Reactivity

Dispatched Domain Events

Dispatched upon state mutation for downstream audit recording, webhook firing, and asynchronous notifications.

⚡ AuditEventLogged

⚡ AuditLogArchived

⚡ IntegrityVerificationFailed

Customization

Extension Points

• External SIEM / SOC forwarding (Elasticsearch, Splunk, Datadog, CloudWatch)
• Sensitive field redaction and masking filters

🛡 Security & Isolation

• Append-only database permissions on production log tables
• Zero UPDATE/DELETE capabilities on audit tables at application level
• Automatic PII masking on designated sensitive attributes

Core Entities & Models

AuditEntry (UUID, tenant_id, actor_id, actor_type, event, target_type, target_id, old_values, new_values, ip, user_agent, created_at)

Related Technical Knowledge

Why Audit Logs Matter in Business-Critical Software

3 min read • Permissions & Security

Designing SaaS for Enterprise Customers

3 min read • SaaS Architecture

What Makes Software Business-Critical?

3 min read • Engineering

Explore Other Platform Modules

Identity & Tenancy

Multi-tenant identity boundaries, user lifecycle, and authentication.

Permissions & Authorization

Hierarchical RBAC, contextual ABAC, and explicit resource policies.

Documents & Storage

S3-compatible asset pipeline, metadata indexing, and access-controlled streaming.

Workflows & State Machines

Deterministic state machine engine with visual transitions and guard conditions.

Notifications & Messaging

Omni-channel delivery engine across Email, SMS, Webhooks, Push, and In-App.

Integrations & Webhooks

Bi-directional webhook engine, REST API gateway, and external sync pipeline.

Reporting & Aggregation

High-performance analytical queries, export queues, and scheduled summaries.