Log Viewer
Easy-to-use, fast, and beautiful
Features | Installation | Configuration | Authorization | 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 yourstorage/logsdirectory, -
🔍 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, - and more...
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
Config file
To publish the config file, run:
php artisan vendor:publish --tag="log-viewer-config"
Route & Middleware
You can easily change the default route and its middleware in the config/log-viewer.php.
See the configuration below:
/*
|--------------------------------------------------------------------------
| Log Viewer Route
|--------------------------------------------------------------------------
| Log Viewer will be available under this URL.
|
*/
'route_path' => 'log-viewer',
/*
|--------------------------------------------------------------------------
| Log Viewer route middleware.
|--------------------------------------------------------------------------
| The middleware should enable session and cookies support in order for the Log Viewer to work.
| The 'web' middleware will be applied automatically if empty.
|
*/
'middleware' => ['web'],
Authorization
Several things can be configured to have different access based on the user logged in, or the log file in action.
Here are the permissions and how to set them up.
Authorizing Log Viewer access
You can limit who has access to the Log Viewer in several ways.
Via "auth" callback
You can limit access to the Log Viewer by providing a custom authorization callback to the LogViewer::auth() method within your AppServiceProvider, like so:
use Opcodes\LogViewer\Facades\LogViewer;
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
LogViewer::auth(function ($request) {
// return true to allow viewing the Log Viewer.
});
// Here's an example:
LogViewer::auth(function ($request) {
return $request->user()
&& in_array($request->user()->email, [
// '[email protected]',
]);
});
}
Via "viewLogViewer" gate
Another easy way to limit access to the Log Viewer is via Laravel Gates. Just define a viewLogViewer authorization gate in your App\Providers\AuthServiceProvider class:
use App\Models\User;
use Illuminate\Support\Facades\Gate;
/**
* Register any authentication / authorization services.
*
* @return void
*/
public function boot()
{
$this->registerPolicies();
Gate::define('viewLogViewer', function (?User $user) {
// return true if the user is allowed access to the Log Viewer
});
}
Via middleware
You can easily add authentication to log viewing routes using popular auth middleware in the config/log-viewer.php.
If your application doesn't use the default authentication solutions, you can use the auth.basic HTTP Basic Authentication middleware.
Note: By default, the auth.basic middleware will assume the email column on your users database table is the user's "username".
See the auth middleware configuration below:
/*
|--------------------------------------------------------------------------
| Log Viewer route middleware.
|--------------------------------------------------------------------------
| The middleware should enable session and cookies support in order for the Log Viewer to work.
| The 'web' middleware will be applied automatically if empty.
|
*/
'middleware' => ['web', 'auth'],
For authorization using Spatie permissions see this discussion
Authorizing log file download
You can limit the ability to download log files via Laravel Gates. Just define a downloadLogFile authorization gate in your App\Providers\AuthServiceProvider class:
use App\Models\User;
use Opcodes\LogViewer\LogFile;
use Illuminate\Support\Facades\Gate;
/**
* Register any authentication / authorization services.
*
* @return void
*/
public function boot()
{
$this->registerPolicies();
Gate::define('downloadLogFile', function (?User $user, LogFile $file) {
// return true if the user is allowed to download the specific log file.
});
}
Authorizing log file deletion
You can limit the ability to delete log files via Laravel Gates. Just define a deleteLogFile authorization gate in your App\Providers\AuthServiceProvider class:
use App\Models\User;
use Opcodes\LogViewer\LogFile;
use Illuminate\Support\Facades\Gate;
/**
* Register any authentication / authorization services.
*
* @return void
*/
public function boot()
{
$this->registerPolicies();
Gate::define('deleteLogFile', function (?User $user, LogFile $file) {
// return true if the user is allowed to delete the specific log file.
});
}
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_urloption in theconfig/livewire.phpfile 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.
4 Nov 29, 2022
540 Jan 5, 2023
4.6k Jan 7, 2023
6 Aug 25, 2022
9 Sep 17, 2022
4 Aug 3, 2022
2.5k Dec 30, 2022
6 Sep 27, 2021
0 Dec 28, 2021
29 Dec 8, 2022
31 Dec 21, 2022
9 Sep 27, 2022
20 Nov 22, 2022
0 Jan 13, 2022
108 Dec 11, 2022
1 Mar 6, 2022
2 Sep 8, 2022
17 Dec 30, 2022
2 Sep 30, 2022