Skip to content

Commit fd6278c

Browse files
committed
updated README for v3
1 parent 1e27934 commit fd6278c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
[OPcodes's](https://www.opcodes.io/) **Log Viewer** is a perfect companion for your [Laravel](https://laravel.com/) app.
2626

27-
You will no longer need to read the raw Laravel log files trying to find what you're looking for.
27+
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.
2828

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

@@ -33,6 +33,7 @@ Log Viewer helps you quickly and clearly see individual log entries, to **search
3333
### Features
3434

3535
- 📂 **View all the Laravel logs** in your `storage/logs` directory,
36+
- 📂 **View other types of logs** - Horizon, Apache, Nginx, Redis, Supervisor, Postgres, and more,
3637
- 🔍 **Search** the logs,
3738
- 🎚 **Filter** by log level (error, info, debug, etc.),
3839
- 🔗 **Sharable links** to individual log entries,
@@ -43,6 +44,7 @@ Log Viewer helps you quickly and clearly see individual log entries, to **search
4344
- 💾 **Download & delete** log files from the UI,
4445
- ☑️ **Horizon** log support (up to Horizon v9.20),
4546
- ☎️ **API access** for folders, files & log entries,
47+
- 💌 **Mail previews** for e-mails sent to the logs,
4648
- and more...
4749

4850
### Documentation
@@ -88,21 +90,19 @@ Here are some common problems and solutions.
8890

8991
### Problem: Logs not loading
9092

91-
At the moment, Log Viewer is only able to process [Laravel logs](https://laravel.com/docs/9.x/logging) that look something like this:
93+
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).
9294

93-
```
94-
[2022-08-25 11:16:17] local.DEBUG: Example log entry for the level debug {"one":1,"two":"two","three":[1,2,3]}
95-
Multiple lines are allowed
96-
and will be picked up as contents
97-
of the same log entry.
98-
```
95+
If your logs are still not showing up, make sure the web process, which Log Viewer runs on, has permission to read these logs.
9996

100-
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.
97+
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).
10198

10299
## Screenshots
103100

104101
Read the **[release blog post](https://arunas.dev/log-viewer-for-laravel/)** for screenshots and more information about Log Viewer's features.
105-
The **[release of v2](https://arunas.dev/log-viewer-v2/)** also includes a few new features.
102+
103+
The **[release of v2](https://arunas.dev/log-viewer-v2/)** includes a few new features in v2.
104+
105+
The **[release of v3](https://arunas.dev/log-viewer-v3/)** includes a few new features in v3.
106106

107107
## Changelog
108108

0 commit comments

Comments
 (0)