Download the PHP package mikailfaruqali/log-viewer without Composer

📋 Snawbar Log Viewer

A modern, elegant, and feature-rich log viewer for Laravel applications. Experience a beautiful glassmorphism-inspired interface that makes viewing and managing your application logs both intuitive and visually appealing.

✨ Features

🎨 Modern UI/UX

• Glassmorphism Design: Beautiful translucent interface with backdrop blur effects
• Dark Theme: Eye-friendly dark interface perfect for development environments
• Responsive Layout: Fully responsive design that works on desktop, tablet, and mobile
• Smooth Animations: CSS transitions and hover effects for enhanced user experience
• Mobile-First: Collapsible sidebar and touch-friendly interactions on mobile devices

📁 File Management

• Smart File Detection: Automatically discovers all .log files in your storage/logs directory
• File Switching: Seamlessly switch between different log files with a single click
• File Deletion: Safely delete old log files directly from the interface with confirmation
• File Sorting: Log files are automatically sorted by modification time (newest first)
• File Status: Visual indicators for active/selected files

📊 Log Parsing & Display

• Dual Format Support: Parses both Laravel's classic text format and Monolog's JSON format
• JSON Log Support: Fully supports structured JSON logs — reads message, level_name, channel, datetime, context, and extra fields
• Multi-line Support: Properly handles stack traces and multi-line log entries
• Log Levels: Color-coded log levels (debug, info, notice, warning, error, critical, alert, emergency)
• Timestamp Formatting: Human-readable timestamp display with ISO 8601 normalization
• Environment Detection: Automatically detects and displays the environment (production, local, etc.)
• Context Badges: Displays inline context badges (tenant, url, method, userId) from JSON logs
• Exception Details: Shows full exception class, message, file location, and chained Caused by exceptions
• Request Input: Renders request input payload from JSON logs in a readable pre-formatted block

🔍 Enhanced Viewing Experience

• Expandable Entries: Click to expand log entries and view full messages and stack traces
• Stack Trace Viewer: Properly formatted stack trace display for debugging
• Message Truncation: Long messages are truncated with ellipsis and expandable on demand
• Empty State Handling: Graceful handling of empty log files and missing selections
• Error Recovery: Robust error handling for corrupted or unreadable log files

🔐 Security & Access Control

• Authentication Required: Protected by Laravel's authentication middleware by default
• Configurable Middleware: Easily add custom authorization middleware
• CSRF Protection: All delete operations are CSRF protected
• Input Validation: Comprehensive validation for all user inputs
• Safe File Operations: Prevents directory traversal and unauthorized file access

⚡ Performance & Reliability

• Efficient Parsing: Optimized log parsing algorithm that handles large files
• Memory Management: Processes logs efficiently without excessive memory usage
• Error Logging: Internal errors are logged for debugging purposes
• Graceful Degradation: Continues working even when individual log files have issues

🛠️ Developer Experience

• Zero Dependencies: No external CSS or JS frameworks required
• Easy Installation: Simple Composer installation with auto-discovery
• Configurable Routes: Customize the route path and middleware
• Publishable Views: Customize the interface to match your application's design
• Clean Architecture: Well-structured codebase following Laravel conventions

🚀 Installation

Requirements: PHP 8.3+ and Laravel 11+

Install the package via Composer:

The package uses Laravel's auto-discovery feature, so no additional setup is required.

⚙️ Configuration

Basic Configuration

The package works out-of-the-box, but you can publish the configuration file for customization:

This creates a config/snawbar-log-viewer.php file:

Advanced Configuration

Custom Route Path:

Custom Middleware:

Role-based Access:

View Customization

Publish the views to customize the interface:

This publishes views to resources/views/vendor/snawbar-log-viewer/ for customization.

📖 Usage

Accessing the Log Viewer

After installation, navigate to the configured route:

Note: You must be authenticated to access the log viewer (default middleware: ['web', 'auth'])

Interface Overview

1. Sidebar: Lists all available log files, sorted by modification date
2. Main Panel: Displays log entries for the selected file
3. Log Entries: Click to expand and view full messages and stack traces
4. Delete Button: Remove old log files (with confirmation)

Log Entry Features

Each log entry displays:

• Log Level: Color-coded badges (debug, info, warning, error, etc.)
• Timestamp: When the log entry was created
• Environment: Application environment (production, local, staging, etc.)
• Message: The log message (truncated with expand option)
• Stack Trace: Full error details and stack trace (when available)

Mobile Experience

The interface is fully responsive:

• Collapsible sidebar on mobile devices
• Touch-friendly interactions
• Optimized layout for smaller screens
• Swipe gestures and mobile navigation

🎨 Screenshots

Desktop View

The main interface showing log files in the sidebar and expanded log entries:

🔧 Advanced Usage

Custom Middleware

Create custom middleware for role-based access:

Register and use the middleware:

Integration with Laravel Gates

Use Laravel's authorization gates:

Environment-Specific Configuration

Configure different access rules per environment:

🧪 Log Format Support

The package supports both Laravel log formats simultaneously in the same file:

Classic Text Format

JSON Format (Monolog JsonFormatter)

To use the JSON formatter in your Laravel application, configure your config/logging.php:

Supported Log Levels

🛡️ Security Considerations

Production Environment

For production use, implement strict access controls:

IP Restriction

Add IP-based restrictions:

Audit Logging

Log access to the log viewer:

🐛 Troubleshooting

Common Issues

1. "No log files found"

• Ensure logs exist in storage/logs/
• Check file permissions (Laravel must be able to read the directory)
• Verify the log files have .log extension

2. "Access denied" or 403 errors

• Check authentication status
• Verify middleware configuration
• Ensure user has required permissions

3. Empty or garbled log entries

• Check log file format compatibility
• Ensure files are not corrupted
• Verify character encoding (UTF-8)

4. Performance issues with large log files

• Consider log rotation
• Archive old log files
• Use Laravel's log rotation features

Debug Mode

Enable debug logging for troubleshooting:

🔄 Log Rotation & Maintenance

Automatic Cleanup

Set up automatic log cleanup:

File Size Management

Monitor and manage large log files:

🤝 Contributing

We welcome contributions! Please see our contributing guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Setup

📚 API Reference

Services

LogFileService

• getLogFiles(): Collection - Get all available log files
• logFileExists(string $filename): bool - Check if log file exists
• getLogFileContent(string $filename): string - Get log file content
• deleteLogFile(string $filename): bool - Delete a log file

LogParserService

• parseLogFile(string $filename): Collection - Parse log file into entries
• parseLogContent(string $content): Collection - Parse log content

LogEntry (Data Object)

• $timestamp - Log entry timestamp
• $environment - Application environment
• $level - Log level (debug, info, warning, error, etc.)
• $message - Log message
• $extra - Additional data (stack traces, context)

Routes

📄 License

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

👨‍💻 Author

Mikail Faruq Ali

• Email: [email protected]
• GitHub: @mikailfaruqali

🙏 Acknowledgments

• Laravel community for the amazing framework
• Bootstrap Icons for the beautiful icons
• All contributors who help improve this package

⭐ If you find this package useful, please give it a star on GitHub! ⭐