Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opcodesio/log-viewer
Fast and beautiful Log Viewer for Laravel
https://github.com/opcodesio/log-viewer
laravel laravel-package laravel8 laravel9 log-viewer logging logs
Last synced: about 7 hours ago
JSON representation
Fast and beautiful Log Viewer for Laravel
- Host: GitHub
- URL: https://github.com/opcodesio/log-viewer
- Owner: opcodesio
- License: mit
- Created: 2022-08-15T07:02:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-10T12:08:17.000Z (11 days ago)
- Last Synced: 2025-01-13T20:03:50.803Z (7 days ago)
- Topics: laravel, laravel-package, laravel8, laravel9, log-viewer, logging, logs
- Language: PHP
- Homepage: https://log-viewer.opcodes.io
- Size: 4.2 MB
- Stars: 3,626
- Watchers: 23
- Forks: 259
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome - opcodesio/log-viewer - Fast and beautiful Log Viewer for Laravel (PHP)
README
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 (and other types of logs) 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,
- 📂 **View other types of logs** - Horizon, Apache, Nginx, Redis, Supervisor, Postgres, and more,
- 🔍 **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,
- 💌 **Mail previews** for e-mails sent to the logs,
- 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
Please see [this page](https://log-viewer.opcodes.io/docs/3.x/log-types/default) for support log formats. If your log has a custom format, or is not supported by Log Viewer out of the box, you will need to [define your own custom log parser](https://log-viewer.opcodes.io/docs/3.x/log-types/custom).
If your logs are still not showing up, make sure the web process, which Log Viewer runs on, has permission to read these logs.
For example, if you want to read the Apache HTTP access logs in `/var/log/httpd`, you will need to make sure that your web process (apache/httpd) has permission to read these files. On unix systems, you can do this with [file ACLs](https://www.thegeekdiary.com/unix-linux-access-control-lists-acls-basics/#:~:text=Every%20file%20on%20any%20UNIX,their%20permission%20to%20the%20file).
## 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/)** includes a few new features in v2.
The **[release of v3](https://arunas.dev/log-viewer-v3/)** includes a few new features in v3.
## 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.