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.
- π 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,
- and more...
- PHP 8.0+
- Laravel 8+
To install the package via composer, Run:
composer require opcodesio/log-viewer
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
)
To publish the config file, run:
php artisan vendor:publish --tag="log-viewer-config"
You can easily change the default route and its middleware in the config/log-viewer.php.
See the configuration below:
/*
|--------------------------------------------------------------------------
| Log Viewer Domain
|--------------------------------------------------------------------------
| You may change the domain where Log Viewer should be active.
| If the domain is empty, all domains will be valid.
|
*/
'route_domain' => null,
/*
|--------------------------------------------------------------------------
| 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'],
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.
You can limit who has access to the Log Viewer in several ways.
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, [
// 'john@example.com',
]);
});
}
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
});
}
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
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.
});
}
You can also limit whether whole folders can be downloaded by defining a downloadLogFolder
authorization gate:
use Opcodes\LogViewer\LogFolder;
//...
Gate::define('downloadLogFolder', function (?User $user, LogFolder $folder) {
// return true if the user is allowed to download the whole folder.
});
NOTE: Individual file permissions are also checked before downloading them, to avoid accidental downloads of protected log files.
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.
});
}
You can also limit whether whole folders can be deleted by defining a deleteLogFolder
authorization gate:
use Opcodes\LogViewer\LogFolder;
//...
Gate::define('deleteLogFolder', function (?User $user, LogFolder $folder) {
// return true if the user is allowed to delete the whole folder.
});
NOTE: Individual file permissions are also checked before deleting them, to avoid accidental deletion of protected log files.
Here are some common problems and solutions.
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 theconfig/livewire.php
file to your app's subdomain:
'asset_url' => '/your-laravel-project',
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.
Read the release blog post for screenshots and more information about Log Viewer's features.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.