README

An elegant log management assistant for Laravel applications. Search, filter, export and monitor logs in real-time with a beautiful, Telescope-inspired UI.

Features

🔍 Advanced Search & Filtering - Search logs by message, level, channel, date range, tags, and user
📤 Export Logs - Export to JSON, CSV, or TXT formats
📋 Saved Snippets - Save and reuse complex search filters
🔐 Authorization Gates - Customizable access control
⚡ Real-time Viewing - See logs appear instantly (with broadcasting)
🎨 Beautiful UI - Telescope-inspired interface built with Vue 3 and Tailwind CSS
💾 Flexible Storage - Database or file-based storage
🏷️ Auto-tagging - Automatic tagging by user, request, session, and IP
🔥 Exception Tracking - Full stack traces and exception details
📊 Statistics Dashboard - Overview of logs by level, channel, and time period

Installation

Install the package via composer:

composer require plusinfolab/logstation

Run the installation command:

php artisan logstation:install

This will:

Publish the configuration file
Publish and run migrations
Publish frontend assets

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=logstation-config

The config file allows you to customize:

Storage driver (database or file)
Database connection
Data retention
Watchers (log, exception, query)
Authorization
Real-time broadcasting
And more...

Authorization

By default, LogStation is only accessible in the local environment. To customize who can access LogStation, publish the config file and modify the authorization.callback:

// config/logstation.php

'authorization' => [
    'callback' => function ($request) {
        // Example 1: Allow specific users
        return in_array($request->user()?->email, [
            'admin@example.com',
            'developer@example.com',
        ]);
        
        // Example 2: Use Laravel Gate
        return Gate::allows('viewLogstation', $request->user());
        
        // Example 3: Check user role
        return $request->user()?->hasRole('admin');
        
        // Example 4: Environment-based
        return app()->environment(['local', 'staging']);
    },
],

You can also define a Gate in your AuthServiceProvider:

use Illuminate\Support\Facades\Gate;

Gate::define('viewLogstation', function ($user) {
    return in_array($user->email, [
        'admin@example.com',
    ]);
});

Or use a Policy:

php artisan make:policy LogStationPolicy

// app/Policies/LogStationPolicy.php
public function view(?User $user): bool
{
    return $user && $user->isAdmin();
}

Enable/Disable

'enabled' => env('LOGSTATION_ENABLED', !app()->environment('production')),

Storage Driver

Choose between database (default) or file:

'driver' => env('LOGSTATION_DRIVER', 'database'),

Database Connection

Use a separate database connection (recommended):

'database' => [
    'connection' => env('LOGSTATION_DB_CONNECTION', config('database.default')),
],

In your .env:

LOGSTATION_DB_CONNECTION=logstation

Then add the connection in config/database.php:

'connections' => [
    'logstation' => [
        'driver' => 'mysql',
        'host' => env('DB_HOST', '127.0.0.1'),
        'database' => 'logstation',
        'username' => env('DB_USERNAME'),
        'password' => env('DB_PASSWORD'),
        // ... other settings
    ],
],

Data Retention

Configure how long to keep logs:

'retention' => [
    'days' => env('LOGSTATION_RETENTION_DAYS', 7),
],

Watchers

Enable/disable specific watchers:

'watchers' => [
    PlusinfoLab\Logstation\Watchers\LogWatcher::class => [
        'enabled' => true,
        'channels' => ['stack', 'single', 'daily'],
        'levels' => ['emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'],
    ],
    PlusinfoLab\Logstation\Watchers\ExceptionWatcher::class => [
        'enabled' => true,
    ],
    PlusinfoLab\Logstation\Watchers\QueryWatcher::class => [
        'enabled' => false,
        'slow' => 100, // Log queries slower than 100ms
    ],
],

Authorization

Customize who can access LogStation:

'authorization' => [
    'callback' => function ($request) {
        return app()->environment('local') ||
               $request->user()?->email === env('LOGSTATION_ADMIN_EMAIL');
    },
],

Or use a Gate:

Gate::define('viewLogstation', function ($user) {
    return in_array($user->email, [
        'admin@example.com',
    ]);
});

Real-time Broadcasting

Enable real-time log updates:

'broadcasting' => [
    'enabled' => env('LOGSTATION_BROADCASTING', false),
    'channel' => 'logstation',
],

Usage

Accessing the Dashboard

Visit /logstation in your browser (configurable via LOGSTATION_PATH).

Programmatic Usage

use PlusinfoLab\Logstation\Facades\Logstation;

// Record a log entry
Logstation::recordLog([
    'level_name' => 'error',
    'message' => 'Something went wrong',
    'context' => ['user_id' => 123],
]);

// Search logs
$logs = Logstation::search([
    'level' => 'error',
    'start_date' => now()->subDays(7),
    'search' => 'payment',
], perPage: 50);

// Get statistics
$stats = Logstation::getStatistics();

// Find specific entry
$entry = Logstation::find($id);

// Delete entry
Logstation::delete($id);

Artisan Commands

# Install LogStation
php artisan logstation:install

# Prune old entries (based on retention config)
php artisan logstation:prune

# Prune entries older than specific days
php artisan logstation:prune --days=30

# Clear all entries
php artisan logstation:clear

# Publish assets
php artisan logstation:publish

Schedule automatic pruning in app/Console/Kernel.php:

protected function schedule(Schedule $schedule)
{
    $schedule->command('logstation:prune')->daily();
}

Search & Filtering

LogStation provides powerful filtering capabilities:

By Level: Filter by log level (emergency, alert, critical, error, warning, notice, info, debug)
By Channel: Filter by log channel
By Date Range: Filter logs within a specific date range
By User: Filter logs by authenticated user
By Tag: Filter by auto-generated or custom tags
Full-text Search: Search in message, exception message, and context

Creating Snippets

Save frequently used filters as snippets:

Apply your desired filters in the UI
Click "Save as Snippet"
Give it a name and description
Reuse anytime from the Snippets menu

Exporting Logs

Export filtered logs in multiple formats:

Apply your filters
Click "Export"
Choose format (JSON, CSV, TXT)
Download the file

Exports are limited to 10,000 entries by default (configurable).

Performance Considerations

Use a Separate Database

For production applications, use a dedicated database connection:

LOGSTATION_DB_CONNECTION=logstation

This prevents LogStation from impacting your main application's performance.

Disable in Production

By default, LogStation is disabled in production. Enable only when needed:

LOGSTATION_ENABLED=true

Regular Pruning

Schedule the prune command to run daily:

$schedule->command('logstation:prune')->daily();

Disable Unnecessary Watchers

Disable watchers you don't need:

'watchers' => [
    PlusinfoLab\Logstation\Watchers\QueryWatcher::class => [
        'enabled' => false, // Disable query watcher
    ],
],

Frontend Development

The UI is built with Vue 3, Inertia.js, and Tailwind CSS. To customize:

# Install dependencies
npm install

# Build for production
npm run build

# Watch for changes
npm run watch

Comparison with Other Tools

Feature	LogStation	Laravel Telescope	Laravel Log Viewer
Log Search	✅	❌	✅
Log Export	✅	❌	✅
Saved Snippets	✅	❌	❌
Real-time Viewing	✅	✅	❌
Exception Tracking	✅	✅	✅
Database Queries	✅	✅	❌
Request Tracking	✅	✅	❌
Beautiful UI	✅	✅	⚠️
File Storage	✅	❌	✅

Security

LogStation is designed for development and debugging. Never expose it publicly in production without proper authentication.

Default security measures:

Only accessible in local environment by default
Customizable authorization callback
Gate-based access control
Configurable middleware

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

Aditya
Inspired by Laravel Telescope
Built with Spatie's Laravel Package Tools

License

The MIT License (MIT). Please see License File for more information.

plusinfolab / logstation

Maintainers

Details

README

Features

Installation

Configuration

Authorization

Enable/Disable

Storage Driver

Database Connection

Data Retention

Watchers

Authorization

Real-time Broadcasting

Usage

Accessing the Dashboard

Programmatic Usage

Artisan Commands

Search & Filtering

Creating Snippets

Exporting Logs

Performance Considerations

Use a Separate Database

Disable in Production

Regular Pruning

Disable Unnecessary Watchers

Frontend Development

Comparison with Other Tools

Security

Testing

Changelog

Contributing

Credits

License