lukewaite/ringphp-guzzle-handler

v2.2.0 2021-04-23 17:01 UTC

Requires

• php: >=7.0
• guzzlehttp/guzzle: ^6.2
• guzzlehttp/psr7: ^1.4
• guzzlehttp/ringphp: ^1.1

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^5.7.11||^6.0||^7.0

MIT

• Luke Waite

README

Usage

Installing

This package can be installed with composer.

$ composer require lukewaite/ringphp-guzzle-handler

Elasticsearch

$guzzleHandler  = new LukeWaite\RingPhpGuzzleHandler\GuzzleHandler();

$client = Elasticsearch\ClientBuilder::create()
            ->setHandler($guzzleHandler)
            ->build();

Optionally, you may create a Guzzle client manually, and pass it through to the constructor:

$guzzle = new GuzzleHttp\Client();
$guzzleHandler  = new LukeWaite\RingPhpGuzzleHandler\GuzzleHandler($guzzle);

$client = Elasticsearch\ClientBuilder::create()
            ->setHandler($guzzleHandler)
            ->build();

What have you done?

I've built a RingPHP Handler that uses Guzzle as the transport.

You've done wot mate?

Yes - I built a handler for RingPHP (an older GuzzleHttp project) that uses Guzzle 6 as the transport.

Reasoning

The ElasticSearch PHP SDK uses the RingPHP client library under the covers. You can provide a Handler when creating the client, but it has to be a RingPHP handler.

NewRelic supports tracking external requests for Guzzle, but not for RingPHP. Using this handler means we can get more accurate instrumentation on our transactions.

Example NewRelic APM Chart, Before and After Deployment

How true to RingPHP is this?

The spec for implementing handlers has been followed, but in some cases I've had to go out of my way to tune this for the ElasticSearch PHP SDK.

$response body

You're supposed to be able to return a lot of different types here, but ElasticSearch expects it to be only a stream, so that's what we return.

$response transfer_stats

Transfer stats is supposed to be an arbitrary array of stats provided by the handler, but it turns out ElasticSearch expects some pretty specific stuff from the default CURL handler to be in there.