Skip to content

feature: Update GuzzleHttpClientAspect to support transfer methods and enhance request logging #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huangdijia merged 5 commits into from
Feb 7, 2025
Merged

feature: Update GuzzleHttpClientAspect to support transfer methods and enhance request logging #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02608fc
feat: 更新 GuzzleHttpClientAspect 以支持 transfer 方法并增强请求记录功能
huangdijia Feb 7, 2025
eb9add7
feat: 更新 GuzzleHttpClientAspect 以支持 transfer 方法并增强请求追踪功能
huangdijia Feb 7, 2025
b212034
feat: 添加或覆盖 on_stats 选项以记录请求持续时间
huangdijia Feb 7, 2025
bf77bee
feat: 增强 GuzzleHttpClientAspect 错误处理，添加异常信息和堆栈跟踪标签
huangdijia Feb 7, 2025
640af58
feat: 更新 GuzzleHttpClientAspect 以使用 RequestInterface 获取请求方法和 URI
huangdijia Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 35 additions & 31 deletions src/sentry/src/Aspect/GuzzleHttpClientAspect.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
use FriendsOfHyperf\Sentry\Integration;
use FriendsOfHyperf\Sentry\Switcher;
use GuzzleHttp\Client;
use GuzzleHttp\TransferStats;
use Hyperf\Di\Aop\AbstractAspect;
use Hyperf\Di\Aop\ProceedingJoinPoint;
use Psr\Http\Message\ResponseInterface;
use Sentry\Breadcrumb;

/**
Expand All @@ -26,8 +26,7 @@
class GuzzleHttpClientAspect extends AbstractAspect
{
public array $classes = [
Client::class . '::request',
Client::class . '::requestAsync',
Client::class . '::transfer',
];

public function __construct(protected Switcher $switcher)
Expand All @@ -36,47 +35,52 @@ public function __construct(protected Switcher $switcher)

public function process(ProceedingJoinPoint $proceedingJoinPoint)
{
// If the guzzle aspect is disabled, we will not record the request.
if (! $this->switcher->isBreadcrumbEnable('guzzle')) {
return $proceedingJoinPoint->process();
}

$startTime = microtime(true);
$instance = $proceedingJoinPoint->getInstance();
$arguments = $proceedingJoinPoint->arguments;
$options = $arguments['keys']['options'] ?? [];
$guzzleConfig = (fn () => $this->config ?? [])->call($instance);
$options = $proceedingJoinPoint->arguments['keys']['options'] ?? [];
$guzzleConfig = (fn () => match (true) {
method_exists($this, 'getConfig') => $this->getConfig(), // @deprecated ClientInterface::getConfig will be removed in guzzlehttp/guzzle:8.0.
property_exists($this, 'config') => $this->config,
default => [],
})->call($proceedingJoinPoint->getInstance());

// If the no_sentry_aspect option is set to true, we will not record the request.
if (($options['no_sentry_aspect'] ?? null) === true || ($guzzleConfig['no_sentry_aspect'] ?? null) === true) {
return $proceedingJoinPoint->process();
}

// Disable the aspect for the requestAsync method.
if ($proceedingJoinPoint->methodName == 'request') {
$proceedingJoinPoint->arguments['keys']['options']['no_sentry_aspect'] = true;
}
$onStats = $options['on_stats'] ?? null;

$uri = (string) ($arguments['keys']['uri'] ?? '');
$data['config'] = $guzzleConfig;
$data['request']['method'] = $arguments['keys']['method'] ?? 'GET';
$data['request']['options'] = $arguments['keys']['options'] ?? [];
$proceedingJoinPoint->arguments['keys']['options']['on_stats'] = function (TransferStats $stats) use ($onStats, $guzzleConfig, $options) {
$request = $stats->getRequest();
$response = $stats->getResponse();

$result = $proceedingJoinPoint->process();
$uri = $request->getUri()->__toString();
$data = [];
$data['config'] = $guzzleConfig;
$data['request']['method'] = $request->getMethod();
$data['request']['options'] = $options;
$data['response']['status'] = $response?->getStatusCode();
$data['response']['reason'] = $response?->getReasonPhrase();
$data['response']['headers'] = $response?->getHeaders();
$data['duration'] = $stats->getTransferTime() * 1000;

if ($result instanceof ResponseInterface) {
$data['response']['status'] = $result->getStatusCode();
$data['response']['reason'] = $result->getReasonPhrase();
$data['response']['headers'] = $result->getHeaders();
}
$data['timeMs'] = (microtime(true) - $startTime) * 1000;
Integration::addBreadcrumb(new Breadcrumb(
Breadcrumb::LEVEL_INFO,
Breadcrumb::TYPE_DEFAULT,
'guzzle',
$uri,
$data
));

Integration::addBreadcrumb(new Breadcrumb(
Breadcrumb::LEVEL_INFO,
Breadcrumb::TYPE_DEFAULT,
'guzzle',
$uri,
$data
));
if (is_callable($onStats)) {
($onStats)($stats);
}
};

return $result;
return $proceedingJoinPoint->process();
}
}
120 changes: 64 additions & 56 deletions src/sentry/src/Tracing/Aspect/GuzzleHttpClientAspect.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
use FriendsOfHyperf\Sentry\Switcher;
use FriendsOfHyperf\Sentry\Tracing\SpanStarter;
use GuzzleHttp\Client;
use GuzzleHttp\TransferStats;
use Hyperf\Context\Context;
use Hyperf\Coroutine\Coroutine;
use Hyperf\Di\Aop\AbstractAspect;
use Hyperf\Di\Aop\ProceedingJoinPoint;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\RequestInterface;
use Sentry\SentrySdk;
use Sentry\Tracing\SpanStatus;
use Throwable;
Expand All @@ -33,8 +34,7 @@ class GuzzleHttpClientAspect extends AbstractAspect
use SpanStarter;

public array $classes = [
Client::class . '::request',
Client::class . '::requestAsync',
Client::class . '::transfer',
];

public function __construct(
Expand All @@ -52,44 +52,25 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
return $proceedingJoinPoint->process();
}

$instance = $proceedingJoinPoint->getInstance();
$arguments = $proceedingJoinPoint->arguments['keys'];
/** @var RequestInterface $request */
$request = $arguments['request'];
$options = $arguments['options'] ?? [];
$guzzleConfig = (fn () => match (true) {
method_exists($this, 'getConfig') => $this->getConfig(), // @deprecated ClientInterface::getConfig will be removed in guzzlehttp/guzzle:8.0.
property_exists($this, 'config') => $this->config,
default => [],
})->call($instance);
})->call($proceedingJoinPoint->getInstance());

// If the no_sentry_tracing option is set to true, we will not record the request.
if (
($options['no_sentry_tracing'] ?? null) === true
|| ($guzzleConfig['no_sentry_tracing'] ?? null) === true
) {
return $proceedingJoinPoint->process();
}

// Disable the aspect for the requestAsync method.
if ($proceedingJoinPoint->methodName == 'request') {
$proceedingJoinPoint->arguments['keys']['options']['no_sentry_tracing'] = true;
}

$uri = (string) ($arguments['uri'] ?? '/');
$method = $arguments['method'] ?? 'GET';
$fullUri = new \GuzzleHttp\Psr7\Uri($uri);

$data = [
// See: https://develop.sentry.dev/sdk/performance/span-data-conventions/#http
'http.query' => $fullUri->getQuery(),
'http.fragment' => $fullUri->getFragment(),
'http.request.method' => $method,
'http.request.body.size' => strlen($arguments['options']['body'] ?? ''),
// Other
'coroutine.id' => Coroutine::id(),
'http.system' => 'guzzle',
'http.guzzle.config' => $guzzleConfig,
'http.guzzle.options' => $arguments['options'] ?? [],
];

// Inject trace context
$parent = SentrySdk::getCurrentHub()->getSpan();
$options['headers'] = array_replace($options['headers'] ?? [], [
'sentry-trace' => $parent->toTraceparent(),
Expand All @@ -98,44 +79,71 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
]);
$proceedingJoinPoint->arguments['keys']['options']['headers'] = $options['headers'];

$span = $this->startSpan('http.client', $method . ' ' . (string) $uri);
// Start span
$span = $this->startSpan('http.client', $request->getMethod() . ' ' . (string) $request->getUri());

try {
$result = $proceedingJoinPoint->process();
if (! $span) {
return $proceedingJoinPoint->process();
}

if (! $span) {
return $result;
$onStats = $options['on_stats'] ?? null;

// Add or override the on_stats option to record the request duration.
$proceedingJoinPoint->arguments['keys']['options']['on_stats'] = function (TransferStats $stats) use ($arguments, $guzzleConfig, $onStats, $span) {
$request = $stats->getRequest();
$response = $stats->getResponse();
$uri = $request->getUri();
$method = $request->getMethod();
$statusCode = $response->getStatusCode();
$data = [
// See: https://develop.sentry.dev/sdk/performance/span-data-conventions/#http
'http.query' => $uri->getQuery(),
'http.fragment' => $uri->getFragment(),
'http.request.method' => $method,
'http.request.body.size' => strlen($arguments['options']['body'] ?? ''),
// Other
'coroutine.id' => Coroutine::id(),
'http.system' => 'guzzle',
'http.guzzle.config' => $guzzleConfig,
'http.guzzle.options' => $arguments['options'] ?? [],
'duration' => $stats->getTransferTime() * 1000, // in milliseconds
'response.status' => $statusCode,
'response.reason' => $response->getReasonPhrase(),
'response.headers' => $response->getHeaders(),
];

if ($this->switcher->isTracingExtraTagEnable('response.body')) {
$data['response.body'] = $response->getBody()->getContents();
$response->getBody()->isSeekable() && $response->getBody()->rewind();
}

if ($result instanceof ResponseInterface) {
$data += [
'response.status' => $result->getStatusCode(),
'response.reason' => $result->getReasonPhrase(),
'response.headers' => $result->getHeaders(),
];
if ($this->switcher->isTracingExtraTagEnable('response.body')) {
$data['response.body'] = $result->getBody()->getContents();
$result->getBody()->rewind();
if (($exception = $stats->getHandlerErrorData()) instanceof Throwable) {
$span->setStatus(SpanStatus::internalError());
$span->setTags([
'error' => true,
'exception.class' => $exception::class,
'exception.message' => $exception->getMessage(),
'exception.code' => $exception->getCode(),
]);
if ($this->switcher->isTracingExtraTagEnable('exception.stack_trace')) {
$data['exception.stack_trace'] = (string) $exception;
}
}
} catch (Throwable $exception) {
$span->setStatus(SpanStatus::internalError());
$span->setTags([
'error' => true,
'exception.class' => $exception::class,
'exception.message' => $exception->getMessage(),
'exception.code' => $exception->getCode(),
]);
if ($this->switcher->isTracingExtraTagEnable('exception.stack_trace')) {
$data['exception.stack_trace'] = (string) $exception;
} elseif ($statusCode >= 400 && $statusCode < 600) {
$span->setStatus(SpanStatus::internalError());
$span->setTags([
'error' => true,
'response.reason' => $response->getReasonPhrase(),
]);
}

throw $exception;
} finally {
$span->setData($data);
$span->finish();
}

return $result;
if (is_callable($onStats)) {
($onStats)($stats);
}
};

return $proceedingJoinPoint->process();
}
}