diff --git a/README.md b/README.md index a169a62..d99eb53 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,22 @@ Algumas informações são capturadas automaticamente pela biblioteca e incluíd - Usuário logado (se houver). - URL atual (se houver). - SQL executado (se houver). -- Guzzle request (se houver) [^1]. +- Guzzle request (se houver). + +Para capturar o Guzzle request, é necessário utilizar o middleware [GuzzleLoggingMiddleware](src/app/Middlewares/GuzzleLoggingMiddleware.php) fornecido pela biblioteca. Segue abaixo um exemplo: + +```php +use GuzzleHttp\HandlerStack; +use GuzzleHttp\Handler\CurlHandler; +use GuzzleHttp\Client; +use Ae3\LaravelLogsLayer\app\Middlewares\GuzzleLoggingMiddleware; + +$handlerStack = HandlerStack::create(new CurlHandler()); +$handlerStack->push(new GuzzleLoggingMiddleware(), 'logger'); + +$clientOptions['handler'] = $handlerStack; +$client = new Client($clientOptions); +``` Você também pode incluir informações que você julgar importantes para a análise do log. Para isso, utilize o parâmetro `$customData` dos métodos de log. Esse parâmetro deve ser um array associativo, onde a chave é o nome do campo e o valor é o valor do campo. Exemplo: @@ -225,21 +240,6 @@ Por padrão, a biblioteca esconde os campos abaixo no corpo da requisição. Voc ___ -[^1]: Para capturar o Guzzle request, é necessário utilizar o middleware [GuzzleLoggingMiddleware](src/app/Middlewares/GuzzleLoggingMiddleware.php) fornecido pela biblioteca. Segue abaixo um exemplo: - -```php -use GuzzleHttp\HandlerStack; -use GuzzleHttp\Handler\CurlHandler; -use GuzzleHttp\Client; -use Ae3\LaravelLogsLayer\app\Middlewares\GuzzleLoggingMiddleware; - -$handlerStack = HandlerStack::create(new CurlHandler()); -$handlerStack->push(new GuzzleLoggingMiddleware(), 'logger'); - -$clientOptions['handler'] = $handlerStack; -$client = new Client($clientOptions); -``` - **Contribuições e Licença** Contribuições para esta biblioteca são bem-vindas! Sinta-se à vontade para contribuir com melhorias, correções de bugs ou novos recursos por meio de pull requests no repositório oficial: [https://git.ae3tecnologia.com.br/AE3_TECNOLOGIA_OPENSOURCE/laravel-logs-layer](https://github.com/ae3/laravel-logs-layer)