Log Viewer
Easy-to-use, fast, and beautiful

Features | Installation | Documentation | Troubleshooting | Credits

OPcodes's Log Viewer is a perfect companion for your Laravel app.

You will no longer need to read the raw Laravel log files trying to find what you're looking for.

Log Viewer helps you quickly and clearly see individual log entries, to search, filter, and make sense of your Laravel logs fast. It is free and easy to install.

📺 Watch a quick 4-minute video showcasing some Log Viewer features.

Features

📂 View all the Laravel logs in your storage/logs directory,
🔍 Search the logs,
🎚 Filter by log level (error, info, debug, etc.),
🔗 Sharable links to individual log entries,
🌑 Dark mode
💾 Download & delete log files from the UI,
☑️ Horizon log support (up to Horizon v9.20)
and more...

Documentation

Documentation can be found on the official website.

Get Started

Requirements

PHP 8.0+
Laravel 8+

Installation

To install the package via composer, Run:

composer require opcodesio/log-viewer

Usage

Once the installation is complete, you will be able to access Log Viewer directly in your browser.

By default, the application is available at: {APP_URL}/log-viewer.

(for example: https://my-app.test/log-viewer)

Configuration

Please visit the Log Viewer Docs to learn about configuring Log Viewer to your needs.

Troubleshooting

Here are some common problems and solutions.

Problem: "Livewire not defined" or other errors in the browser's console

This is most often caused by your project being served from a sub-folder, like example.com/your-laravel-project/log-viewer.

Livewire by default tries to load its resources from the root of the domain, like example.com/livewire/livewire.js, but if that's outside your project's sub-folder, then you need to set a different asset_url. You can read more about it here.

Fortunately, the fix is easy:

Publish the Livewire config:

php artisan livewire:publish --config

Set the asset_url option in the config/livewire.php file to your app's subdomain:

    'asset_url' => '/your-laravel-project',

Problem: Logs not loading

At the moment, Log Viewer is only able to process Laravel logs that look something like this:

[2022-08-25 11:16:17] local.DEBUG: Example log entry for the level debug {"one":1,"two":"two","three":[1,2,3]}
Multiple lines are allowed
and will be picked up as contents
of the same log entry.

If your logs are structured differently, then you'll have to wait until we ship support for custom log formats. Otherwise, please adjust your log format to Laravel's default.

Screenshots

Read the release blog post for screenshots and more information about Log Viewer's features.

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

websterl3o / log-viewer Goto Github PK

log-viewer's Introduction

Log ViewerEasy-to-use, fast, and beautiful