Skip to content

Commit 5c3679f

Browse files
committed
Adds readme
1 parent da8cef4 commit 5c3679f

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.MD

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Laravel Correlation ID Middleware
2+
Supports L5.5+
3+
4+
This package offers you a way of adding a correlation id output on Laravel Logger based on a sent Header.
5+
Inspired by [this repo](https://github.com/proemergotech/correlate-php-laravel) it has:
6+
7+
- all the functionality to set macros on a Request and Push a Monolog Processor
8+
- adds a configuration file to override settings
9+
- adds proper tests
10+
- enables usage for recent Laravel versions (5.5+)
11+
12+
## Install
13+
14+
### Add Service provider
15+
Open your config/app.php and insert the following in providers key:
16+
```
17+
Ajaaleixo\Middleware\CorrelationId\CorrelationIdServiceProvider::class,
18+
```
19+
20+
### Run Publish command
21+
```
22+
php artisan vendor:publish --provider="Ajaaleixo\Middleware\CorrelationId\CorrelationIdServiceProvider"
23+
```
24+
25+
### Edit your settings
26+
Open ```config/correlationid.php```.
27+
28+
## Roadmap
29+
TODO
30+
31+

0 commit comments

Comments
 (0)