Download the PHP package infinitypaul/laravel-dynamodb-auditing without Composer

Laravel DynamoDB Auditing

A DynamoDB driver for the Laravel Auditing package, allowing you to store audit logs in AWS DynamoDB instead of a traditional database.

Features

• High Performance: Store audit logs in DynamoDB for better scalability
• Auto-scaling: DynamoDB handles scaling automatically
• TTL Support: Automatic cleanup of old audit logs
• Flexible Schema: NoSQL structure for varying audit data
• Query Service: Built-in service for querying audit logs
• Laravel Integration: Seamless integration with Laravel Auditing
• Queue Support: Optional queue processing for improved performance

Installation

1. Install via Composer

2. Publish Configuration

3. Configure Environment Variables

Add the following to your .env file:

4. Configure Laravel Auditing Driver

Add the DynamoDB driver configuration to your config/audit.php file in the drivers array:

5. Create DynamoDB Table

DynamoDB Table Structure

The package uses the following DynamoDB table structure:

Primary Key Design

• Partition Key (PK): {auditable_type}#{auditable_id} (e.g., App\Models\Wallet#12345)
• Sort Key (SK): {timestamp}#{audit_id} (for chronological ordering)

Global Secondary Index (GSI)

• CreatedAtIndex: For recent audit browsing
• Partition Key: audit_type (always "AUDIT")
• Sort Key: created_at (timestamp)

Attributes

• audit_id - Unique identifier for the audit
• user_id - ID of the user who performed the action
• event - Type of event (created, updated, deleted, etc.)
• auditable_type - Model class name
• auditable_id - Model ID
• old_values - JSON of old values
• new_values - JSON of new values
• url - Request URL
• ip_address - User's IP address
• user_agent - User's browser/client
• created_at - Timestamp
• TTL - Time-to-live for automatic cleanup

Setup

Quick Setup (Recommended)

The installer automatically:

• ✅ Checks for migration conflicts
• ✅ Publishes configuration
• ✅ Creates DynamoDB table with GSI
• ✅ Tests the installation
• ✅ Provides next steps

Manual Setup (Advanced)

If you prefer step-by-step control:

1. Create DynamoDB Table

2. Test the Setup

Usage

Basic Usage

Once configured, the package works automatically with Laravel Auditing:

Queue Processing (Recommended for Production)

For high-traffic applications, enable queue processing to improve performance:

Benefits of Queue Processing:

• Faster Response Times: Audit writes don't block user requests
• Better Scalability: Handle high-volume audit operations
• Resilience: Failed audit writes are automatically retried
• Non-blocking: User operations continue even if DynamoDB is temporarily unavailable

Queue Worker Setup:

Note: When queue processing is enabled, audit logs are processed asynchronously, so they may not be immediately available for querying.

Querying Audit Logs

Use the provided AuditQueryService:

Configuration

Environment Variables

Configuration File

The config/dynamodb-auditing.php file allows you to customize:

• AWS credentials and region
• Table name and TTL settings
• Local vs production configurations

TTL (Time-To-Live) Configuration

Control automatic cleanup of audit logs:

Important: Setting DYNAMODB_AUDIT_TTL_DAYS=null will keep audit logs forever, which may increase storage costs over time.

Performance Considerations

Why DynamoDB for Audit Logs?

DynamoDB excels at audit log storage because:

• Consistent Performance: O(1) read/write operations regardless of table size
• Horizontal Scaling: Automatically scales to handle millions of records
• Efficient Queries: Partition + Sort key design enables fast lookups
• No Performance Degradation: Unlike SQL databases, performance doesn't degrade with table growth

Testing

Run the package tests:

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Submit a pull request

Commands

The package provides several Artisan commands for setup and testing:

Command Examples

Repository & Support

• 📦 GitHub Repository: https://github.com/infinitypaul/laravel-dynamodb-auditing
• 📚 Documentation: Available in the repository
• 🐛 Issues & Bug Reports: GitHub Issues
• 💬 Feature Requests: GitHub Issues

License

This package is open-sourced software licensed under the MIT license.