class ClientRequestWatcher extends Watcher

Constants

protected DEFAULT_REQUEST_SIZE_LIMIT

Methods

__construct(array $options = [])

Create a new watcher instance.

from  Watcher
void
register(Application $app)

Register the watcher.

setOptions(array $options)

Set the watcher options.

from  Watcher
array
hideParameters(array $data, array $hidden)

Hide the given parameters.

from  Watcher
mixed
recordRequest(ProceedingJoinPoint $proceedingJoinPoint)

Record a Guzzle request intercepted via AOP.

bool
shouldIgnoreHost(string $host)

Determine whether to ignore this request based on its host.

array
buildRequestData(RequestInterface $request, TransferStats $stats, array $options)

Build the request data array for a completed transfer.

array|string
buildPayload(RequestInterface $request, array $options)

Build the request payload, using structured Hypervel data when available.

array|string
structuredPayload(RequestInterface $request, array $data)

Format the structured payload from Hypervel's HTTP client.

array
formatMultipartData(array $data)

Format multipart data for display.

array|string
payload(array $payload)

Format the structured payload with size limit and parameter hiding.

array|string
formatStructuredPayload(array $payload, array $hidden, int $sizeLimit)

Format a structured payload for entry storage.

array|string
getRequestPayload(RequestInterface $request)

Extract the payload from the raw PSR-7 request body.

array
getResponse(ResponseInterface $response)

Extract response data from the PSR-7 response.

array|string
getResponsePayload(ResponseInterface $response)

Extract the payload from the PSR-7 response body.

array
headers(array $headers)

Format the given headers.

Details

in Watcher at line 18
__construct(array $options = [])

Create a new watcher instance.

Parameters

array $options

the configured watcher options

at line 34
void register(Application $app)

Register the watcher.

Interception is handled by GuzzleHttpClientAspect via AOP.

Parameters

Application $app

Return Value

void

in Watcher at line 31
Watcher setOptions(array $options)

Set the watcher options.

Parameters

array $options

Return Value

Watcher

in Watcher at line 41
protected array hideParameters(array $data, array $hidden)

Hide the given parameters.

Parameters

array $data
array $hidden

Return Value

array

at line 41
mixed recordRequest(ProceedingJoinPoint $proceedingJoinPoint)

Record a Guzzle request intercepted via AOP.

Parameters

ProceedingJoinPoint $proceedingJoinPoint

Return Value

mixed

at line 135
protected bool shouldIgnoreHost(string $host)

Determine whether to ignore this request based on its host.

Parameters

string $host

Return Value

bool

at line 143
protected array buildRequestData(RequestInterface $request, TransferStats $stats, array $options)

Build the request data array for a completed transfer.

Parameters

RequestInterface $request
TransferStats $stats
array $options

Return Value

array

at line 164
protected array|string buildPayload(RequestInterface $request, array $options)

Build the request payload, using structured Hypervel data when available.

When the request originated from Hypervel's HTTP client, the caller's structured payload is available in the hypervel_data Guzzle option. Body replacements made later by before-sending callbacks do not rewrite those original options, so this describes caller intent and may differ from bytes replaced later in the handler stack. Raw and third-party traffic is parsed from the PSR-7 body instead.

Parameters

RequestInterface $request
array $options

Return Value

array|string

at line 176
protected array|string structuredPayload(RequestInterface $request, array $data)

Format the structured payload from Hypervel's HTTP client.

Parameters

RequestInterface $request
array $data

Return Value

array|string

at line 193
protected array formatMultipartData(array $data)

Format multipart data for display.

Parameters

array $data

Return Value

array

at line 227
protected array|string payload(array $payload)

Format the structured payload with size limit and parameter hiding.

Parameters

array $payload

Return Value

array|string

at line 239
protected array|string formatStructuredPayload(array $payload, array $hidden, int $sizeLimit)

Format a structured payload for entry storage.

Parameters

array $payload
array $hidden
int $sizeLimit

Return Value

array|string

at line 263
protected array|string getRequestPayload(RequestInterface $request)

Extract the payload from the raw PSR-7 request body.

Parameters

RequestInterface $request

Return Value

array|string

at line 333
protected array getResponse(ResponseInterface $response)

Extract response data from the PSR-7 response.

Parameters

ResponseInterface $response

Return Value

array

at line 345
protected array|string getResponsePayload(ResponseInterface $response)

Extract the payload from the PSR-7 response body.

Parameters

ResponseInterface $response

Return Value

array|string

at line 407
protected array headers(array $headers)

Format the given headers.

Parameters

array $headers

Return Value

array