Skip to content

Latest commit

 

History

History
126 lines (80 loc) · 4.92 KB

README.md

File metadata and controls

126 lines (80 loc) · 4.92 KB
Raw

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

Documentation | Features | Installation | Troubleshooting | Credits

Packagist Packagist PHP from Packagist Laravel Version

log-viewer-light-dark

OPcodes's Log Viewer is a perfect companion for your Laravel 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 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.

Get Started

Requirements

  • PHP 8.0+
  • Laravel 8+

Installation

To install the package via composer, Run:

composer require opcodesio/log-viewer

After installing the package, publish the front-end assets by running:

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 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 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.

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.

Screenshots

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

The release of v2 includes a few new features in v2.

The release of v3 includes a few new features in v3.

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.