Log Viewer
Easy-to-use, fast, and beautiful
Documentation |
Features |
Installation |
Troubleshooting |
Credits
[OPcodes's](https://www.opcodes.io/) **Log Viewer** is a perfect companion for your [Laravel](https://laravel.com/) 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](https://www.youtube.com/watch?v=q7SnF2vubRE)** 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**,
- 📱 **Mobile-friendly** UI,
- 🖥️ **Multiple host support**,
- ⌨️ **Keyboard accessible**,
- 💾 **Download & delete** log files from the UI,
- ☑️ **Horizon** log support (up to Horizon v9.20),
- ☎️ **API access** for folders, files & log entries,
- and more...
### Documentation
Documentation can be found on the [official website](https://log-viewer.opcodes.io/).
## Get Started
### Requirements
- **PHP 8.0+**
- **Laravel 8+**
### Installation
To install the package via composer, Run:
```bash
composer require opcodesio/log-viewer
```
After installing the package, publish the front-end assets by running:
```bash
php artisan log-viewer:publish
```
### 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](https://log-viewer.opcodes.io/docs)** to learn about configuring Log Viewer to your needs.
## Troubleshooting
Here are some common problems and solutions.
### Problem: Logs not loading
At the moment, Log Viewer is only able to process [Laravel logs](https://laravel.com/docs/9.x/logging) 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](https://arunas.dev/log-viewer-for-laravel/)** for screenshots and more information about Log Viewer's features.
The **[release of v2](https://arunas.dev/log-viewer-v2/)** also includes a few new features.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Arunas Skirius](https://github.com/arukompas)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.