Download the PHP package twentysix22/laraveleslogs without Composer
On this page you can find all versions of the php package twentysix22/laraveleslogs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download twentysix22/laraveleslogs
More information about twentysix22/laraveleslogs
Files in twentysix22/laraveleslogs
Package laraveleslogs
Short Description Elasticsearch structured logging for Laravel
License MIT
Homepage https://github.com/twentysix22/laraveleslogs
Informations about the package laraveleslogs
LaravelESLogs
Structured logging for Laravel into Elasticsearch. Log your Requests and Jobs easily alongside key contextual information to elastic search indexes for easy searching and analysis.
Take a look at contributing.md to see a to do list.
Installation
Via Composer
Usage
Publish the provider in laravel:
Add the route middleware alias to the app/Http/Kernel.php
Configure .env
Add the service provider to your providers array in config/app.php
Initialise the Elasticsearch indices.
This step is not strictly necessary unless you wish to reset any current indices.
Configure auto cleanup of logs by retention days.
You can run a daily command to clear up old logs which will use the LOG_ELASTICSEARCH_KEEP_DAYS
env variable number of days retention.
Logging Requests
Apply the middleware 'log:{namespace}' to your routes to start logging requests. (you can omit the namespace param if you want to but its useful to specify for clarity in logs) eg:
You can add this middleware to individual routes, groups, or even your global route middlware if you wish to simply log out every request/response. (but we recommend you be more specific in your logging :-) )
Adding Request Context
You can use the Trait use ReportsRequestContext;
in your request controllers. This gives a coupld of options to apply context to your logs.
Logging Jobs
Logging of jobs will be enabled by default if you configure your .env as above.
Logging Job Context
You can log out context to your jobs using similar trait to requests above - add use ReportsJobContext;
to your Job.
eg:
Setting custom context name.
You can set a custom context name using traits ReportsJobContext
or ReportsRequestContext
Redaction of sensitive information from logs.
Its important that you do not log out sensitive information in logs for various data protection reasons. You can configure a list of sensitive keys that you would like to redact from your logs in your /config/laraveleslogs.php
:
You can also specify the redaction ink string that will replace these sensitive keys by configuring the LOG_REDACTION_INK
env variable.
Change log
Please see the changelog for more information on what has changed recently.
Testing
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email author email instead of using the issue tracker.
Credits
- author name
- All Contributors
License
license. Please see the license file for more information.
All versions of laraveleslogs with dependencies
illuminate/support Version ^8.0
elasticsearch/elasticsearch Version ^7.8
ramsey/uuid Version ^4.1
laravel/helpers Version ^1.2