README

Simple log aggregation for Laravel applications. Send your logs to 401 Clicks with just a few environment variables.

Installation

composer require 401Clicks/laravel-logger

Quick Start

Add these to your .env file:

LOG_CHANNEL=stack
LOG_STACK=single,clicks

CLICKS_API_TOKEN=your-api-token-here

That's it! Your logs will now be sent to 401 Clicks.

Configuration

Environment Variables

Publishing Config

To customize the configuration:

php artisan vendor:publish --tag=clicks-logger-config

Manual Channel Configuration

If you prefer to configure the channel manually in config/logging.php:

'channels' => [
    // ... other channels

    'clicks' => [
        'driver' => 'clicks',
        'url' => env('CLICKS_LOG_URL', 'https://logs.401clicks.com/api/v1/logs'),
        'token' => env('CLICKS_API_TOKEN'),
        'level' => env('CLICKS_LOG_LEVEL', 'debug'),
    ],
],

Usage

Once configured, just use Laravel's standard logging:

use Illuminate\Support\Facades\Log;

Log::info('User logged in', ['user_id' => $user->id]);
Log::error('Payment failed', ['order_id' => $order->id, 'error' => $e->getMessage()]);

Using with Stack Channel

The recommended setup uses Laravel's stack channel to log locally AND send to 401 Clicks:

LOG_CHANNEL=stack
LOG_STACK=single,clicks

This way you keep local logs while also sending them to 401 Clicks.

Logging to Clicks Only

To only send logs to 401 Clicks:

LOG_CHANNEL=clicks

Sensitive Data Masking

The logger automatically masks sensitive data before it leaves your application. This is the most secure approach as PII and credentials never reach any external service.

Default Behavior

By default, masking is enabled and will detect and mask:

• Credit card numbers (Visa, MasterCard, Amex, Discover, JCB)
• Social Security Numbers (XXX-XX-XXXX format)
• API keys (sk_, pk_, Bearer tokens)
• Passwords in key-value contexts
• Phone numbers (US formats)

Configuration

Configure masking via environment variables or the config file:

# Disable masking entirely (not recommended)
CLICKS_MASKING_ENABLED=false

# Change masking style: full, partial, or hash
CLICKS_MASKING_STYLE=full

Available masking styles:

Custom Patterns

Add custom patterns in your config/clicks-logger.php:

'masking' => [
    'custom_patterns' => [
        [
            'name' => 'Customer IDs',
            'pattern' => '/CUST-[A-Z0-9]{8}/i',
            'replacement' => '[CUSTOMER_ID]',
        ],
        [
            'name' => 'Internal Order Numbers',
            'pattern' => '/ORD-\d{10}/',
            'replacement' => '[ORDER_ID]',
        ],
    ],
],

Enabling Additional Patterns

To mask email addresses or IP addresses, update the patterns array:

'masking' => [
    'patterns' => [
        'credit_cards',
        'ssn',
        'api_keys',
        'passwords',
        'phone_numbers',
        'emails',       // Now enabled
        'ip_addresses', // Now enabled
    ],
],

Server-Side Fallback

401 Clicks also provides server-side masking for logs sent via cURL or other methods that don't use this package. Configure server-side masking in your project settings at 401clicks.com.

How It Works

• Logs are batched (default: 10 logs or 5 seconds)
• Sensitive data is masked before batching (client-side)
• Batches are sent via HTTP POST to the 401 Clicks API
• Failed sends are logged to stderr (won't break your app)
• Remaining logs are flushed on shutdown

Getting Your API Token

1. Go to 401clicks.com
2. Navigate to your project settings
3. Create a new API token
4. Copy the token to your .env file

Requirements

• PHP 8.1+
• Laravel 10, 11, or 12
• Guzzle HTTP client

License

MIT License