mvd81 / laravel-logreader
A Laravel client package to read /search and browse log files for logreader.dev
Requires
- php: ^8.1
- illuminate/routing: ^10.0|^11.0|^12.0|^13.0
- illuminate/support: ^10.0|^11.0|^12.0|^13.0
Requires (Dev)
- orchestra/testbench: ^8.0|^9.0|^10.0|^11.0
- phpunit/phpunit: ^10.0|^11.0
README
This is the client package for logreader.dev. Install it on your Laravel application to allow the Logreader to remotely read your log files via a secure API.
Installation
composer require mvd81/laravel-logreader
Configuration
Publish the config file:
php artisan vendor:publish --tag=logreader-config
Token
Add the token you received from the Logreader application to your .env:
LOGREADER_TOKEN=your-token-here
You can find this token in the logreader.dev dashboard after registering your application.
Options
| Option | Env variable | Default | Description |
|---|---|---|---|
enabled |
LOGREADER_ENABLED |
true |
Enable or disable the API |
token |
LOGREADER_TOKEN |
null |
Token provided by the Logreader app |
exclude_logs |
LOGREADER_EXCLUDE_LOGS |
'' |
Comma-separated list of files/patterns to exclude |
context.enabled |
LOGREADER_CONTEXT_ENABLED |
false |
Add request URL and HTTP method to every log entry |
To disable the logreader without removing the package:
LOGREADER_ENABLED=false
To exclude specific log files or directories:
LOGREADER_EXCLUDE_LOGS=passwords.log,private/*,*.tmp
Request context
When enabled, a global middleware is automatically registered that adds the following to every log entry using Log::shareContext():
| Field | Description |
|---|---|
url |
Full URL of the request |
method |
HTTP method (GET, POST, etc.) |
This makes it easier to correlate log entries with the request that caused them when browsing logs in the dashboard.
LOGREADER_CONTEXT_ENABLED=true
License
MIT