Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gmponos/guzzle-log-middleware
A Guzzle middleware to log request and responses automatically
https://github.com/gmponos/guzzle-log-middleware
composer guzzle guzzle-middleware guzzlehttp http log logger logger-middleware middleware php php7 psr-3 rejection
Last synced: 7 days ago
JSON representation
A Guzzle middleware to log request and responses automatically
- Host: GitHub
- URL: https://github.com/gmponos/guzzle-log-middleware
- Owner: gmponos
- License: mit
- Created: 2016-04-03T20:12:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T06:03:14.000Z (3 months ago)
- Last Synced: 2024-10-16T12:41:32.092Z (20 days ago)
- Topics: composer, guzzle, guzzle-middleware, guzzlehttp, http, log, logger, logger-middleware, middleware, php, php7, psr-3, rejection
- Language: PHP
- Homepage:
- Size: 140 KB
- Stars: 73
- Watchers: 3
- Forks: 24
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Guzzle Log Middleware
[](https://codecov.io/gh/gmponos/guzzle-log-middleware)
[](https://packagist.org/packages/gmponos/guzzle_logger)
[](https://travis-ci.org/gmponos/guzzle-log-middleware)
[](https://github.com/gmponos/monolog-slack/blob/master/LICENSE.md)
This is a middleware for [guzzle](https://github.com/guzzle/guzzle) that will help you automatically log every request
and response using a PSR-3 logger.
The middleware is functional with version 6 of Guzzle.
## Install
Via Composer
``` bash
$ composer require gmponos/guzzle_logger
```
## Usage
### Simple usage
```php
use GuzzleLogMiddleware\LogMiddleware;
use GuzzleHttp\HandlerStack;
$logger = new Logger(); //A new PSR-3 Logger like Monolog
$stack = HandlerStack::create(); // will create a stack stack with middlewares of guzzle already pushed inside of it.
$stack->push(new LogMiddleware($logger));
$client = new GuzzleHttp\Client([
'handler' => $stack,
]);
```
From now on each request and response you execute using `$client` object will be logged.
By default the middleware logs every activity with level `DEBUG`.
### Advanced initialization
The signature of the `LogMiddleware` class is the following:
```php
\GuzzleLogMiddleware\LogMiddleware(
\Psr\Log\LoggerInterface $logger,
\GuzzleLogMiddleware\Handler\HandlerInterface $handler = null,
bool $onFailureOnly = false,
bool $logStatistics = false
);
```
- **logger** - The PSR-3 logger to use for logging.
- **handler** - A HandlerInterface class that will be responsible for logging your request/response. Check Handlers sections.
- **onFailureOnly** - By default the middleware is set to log every request and response. If you wish to log
the HTTP messages only when guzzle returns a rejection set this as true or when an exception occurred.
Guzzle returns a rejection when [http_errors](http://docs.guzzlephp.org/en/stable/request-options.html#http-errors) option is set to true.
- **logStatistics** - If you set this option as true then the middleware will also log statistics about the HTTP transaction.
### Handlers
In order to make the middleware more flexible we allow the developer to initialize it with a handler.
A handler is the class that will be responsible for logging the HTTP message and it must implement a `HandlerInterface`.
As an example let's say that we create the following handler:
```php
debug('Guzzle HTTP request: ' . \GuzzleHttp\Psr7\str($request));
return;
}
}
```
We can pass the handler above during construction of the middleware.
```php
push(new LogMiddleware($logger, new SimpleHandler()));
$client = new GuzzleHttp\Client([
'handler' => $stack,
]);
```
From now on all Requests will be logged. Note that at the example above only requests are logged.
**Important**
If no handler is passed the middleware will initialize it's own handler. At the moment the default one is `MultiRecordArrayHandler`
#### MultiRecordArrayHandler
This is the default handler used from the middleware. This handler uses internally the `FixedStrategy` and logs all request
and responses with level debug. This handler adds a separate log entry for each `Request`, `Response`, `Exception` or `TransferStats`.
The information about each object are added as a `context` array to the log entry.
#### StringHandler
This handler uses internally the `FixedStrategy` and logs all request and responses with level debug. You can initialize this handler
with a custom strategy. This handler adds a separate log entry for each Request, Response, Exception or TransferStats.
The handler converts the objects to strings and the information about each object are added to the `message` of the log entry.
### Log Level Strategies
Strategies are used to define the LogLevel that the handler will use to log each object.
#### FixedStrategy
You can use this strategy to log each HTTP Message with a specific level.
#### StatusCodeStrategy
You can use this strategy to log each HTTP Response with a specific level depending on the status code of the Response.
```php
$strategy = new StatusCodeStrategy(
LogLevel::INFO, // Default level used for requests or for responses that status code are not set with a different level.
LogLevel::CRITICAL // Default level used for exceptions.
);
$strategy->setLevel(404, LogLevel::WARNING);
$multiRecordArrayHandler = new MultiRecordArrayHandler($strategy);
$logger = new Logger(); //A new PSR-3 Logger like Monolog
$stack = HandlerStack::create(); // will create a stack stack with middlewares of guzzle already pushed inside of it.
$stack->push(new LogMiddleware($logger, $multiRecordArrayHandler));
$client = new GuzzleHttp\Client([
'handler' => $stack,
]);
```
### Using options on each request
You can set on each request options about your log.
```php
$client->get('/', [
'log' => [
'on_exception_only' => true,
'statistics' => true,
]
]);
```
- ``on_exception_only`` Do not log anything unless if the response status code is above the threshold.
- ``statistics`` if the `on_exception_only` option/variable is true and this is also true the middleware will log statistics about the HTTP call.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Credits
- [George Mponos]([email protected])
- [Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.