Skip to content

feat(pii): apply data collection to guzzle middleware #2218

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
Litarnus merged 4 commits into from
Oct 1, 2026
Merged

feat(pii): apply data collection to guzzle middleware #2218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bf155e
feat(pii): apply data collection to guzzle middleware
Litarnus Sep 21, 2026
1f68f37
feat(pii): apply data collection to guzzle middleware
Litarnus Sep 21, 2026
c46251a
CS
Litarnus Sep 22, 2026
2002d9e
refactor
Litarnus Sep 23, 2026
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
102 changes: 77 additions & 25 deletions src/Tracing/GuzzleTracingMiddleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Sentry\Breadcrumb;
use Sentry\ClientInterface;
use Sentry\DataCollection\DataCollectionPolicy;
use Sentry\DataCollection\HttpCookieCollector;
use Sentry\DataCollection\HttpHeaderCollector;
use Sentry\DataCollection\HttpMessageType;
use Sentry\DataCollection\HttpUrlCollector;
use Sentry\Options;
use Sentry\SentrySdk;
use Sentry\State\HubInterface;

Expand All @@ -28,32 +33,47 @@ public static function trace(?HubInterface $hub = null): \Closure
$hub = $hub ?? SentrySdk::getCurrentHub();
$client = $hub->getClient();
$parentSpan = $hub->getSpan();
$requestUri = $request->getUri();

$partialUri = Uri::fromParts([
'scheme' => $request->getUri()->getScheme(),
'host' => $request->getUri()->getHost(),
'port' => $request->getUri()->getPort(),
'path' => $request->getUri()->getPath(),
'scheme' => $requestUri->getScheme(),
'host' => $requestUri->getHost(),
'port' => $requestUri->getPort(),
'path' => $requestUri->getPath(),
]);

$sdkOptions = $client !== null ? $client->getOptions() : null;
$policy = DataCollectionPolicy::fromOptions($sdkOptions);
$spanAndBreadcrumbData = [
'http.request.method' => $request->getMethod(),
'http.request.body.size' => $request->getBody()->getSize(),
];

if ($request->getUri()->getQuery() !== '') {
$spanAndBreadcrumbData['http.query'] = $request->getUri()->getQuery();
$queryString = HttpUrlCollector::collectQueryString($policy, $requestUri->getQuery());
if ($queryString !== null) {
$spanAndBreadcrumbData['http.query'] = $queryString;
}
if ($request->getUri()->getFragment() !== '') {
$spanAndBreadcrumbData['http.fragment'] = $request->getUri()->getFragment();

if ($requestUri->getFragment() !== '') {
$spanAndBreadcrumbData['http.fragment'] = $requestUri->getFragment();
}

$fullUrl = HttpUrlCollector::collect($policy, HttpMessageType::outgoingRequest(), $requestUri);
if ($fullUrl !== null) {
$spanAndBreadcrumbData['url.full'] = $fullUrl;
}

$breadcrumbUrl = $fullUrl ?? (string) $partialUri;
$childSpan = null;

if ($parentSpan !== null && $parentSpan->getSampled()) {
$spanData = $spanAndBreadcrumbData;
self::addHeaderData($spanData, 'http.request.header', HttpHeaderCollector::collect($policy, HttpMessageType::outgoingRequest(), $request->getHeaders()));
self::addCookieData($spanData, 'http.request.header.cookie', HttpCookieCollector::collectPsr7Request($policy, HttpMessageType::outgoingRequest(), $request));

$spanContext = new SpanContext();
$spanContext->setOp('http.client');
$spanContext->setData($spanAndBreadcrumbData);
$spanContext->setData($spanData);
$spanContext->setOrigin('auto.http.guzzle');
$spanContext->setDescription($request->getMethod() . ' ' . $partialUri);

Expand All @@ -62,7 +82,7 @@ public static function trace(?HubInterface $hub = null): \Closure
$hub->setSpan($childSpan);
}

if (self::shouldAttachTracingHeaders($client, $request)) {
if (self::shouldAttachTracingHeaders($sdkOptions, $request)) {
$traceParent = getTraceparent();
if ($traceParent !== '') {
$request = $request->withHeader('sentry-trace', $traceParent);
Expand All @@ -74,7 +94,7 @@ public static function trace(?HubInterface $hub = null): \Closure
}
}

$handlerPromiseCallback = static function ($responseOrException) use ($hub, $spanAndBreadcrumbData, $childSpan, $parentSpan, $partialUri) {
$handlerPromiseCallback = static function ($responseOrException) use ($hub, $spanAndBreadcrumbData, $childSpan, $parentSpan, $breadcrumbUrl, $policy) {
if ($childSpan !== null) {
// We finish the span (which means setting the span end timestamp) first to ensure the measured time
// the span spans is as close to only the HTTP request time and do the data collection afterwards
Expand All @@ -93,21 +113,26 @@ public static function trace(?HubInterface $hub = null): \Closure

$breadcrumbLevel = Breadcrumb::LEVEL_INFO;

if ($response !== null) {
if ($response instanceof ResponseInterface) {
$statusCode = $response->getStatusCode();
$spanAndBreadcrumbData['http.response.body.size'] = $response->getBody()->getSize();
$spanAndBreadcrumbData['http.response.status_code'] = $response->getStatusCode();
$spanAndBreadcrumbData['http.response.status_code'] = $statusCode;

if ($response->getStatusCode() >= 400 && $response->getStatusCode() < 500) {
if ($statusCode >= 400 && $statusCode < 500) {
$breadcrumbLevel = Breadcrumb::LEVEL_WARNING;
} elseif ($response->getStatusCode() >= 500) {
} elseif ($statusCode >= 500) {
$breadcrumbLevel = Breadcrumb::LEVEL_ERROR;
}
}

if ($childSpan !== null) {
if ($response !== null) {
if ($response instanceof ResponseInterface) {
$spanData = $spanAndBreadcrumbData;
self::addHeaderData($spanData, 'http.response.header', HttpHeaderCollector::collect($policy, HttpMessageType::incomingResponse(), $response->getHeaders()));
self::addCookieData($spanData, 'http.response.header.set_cookie', HttpCookieCollector::collectPsr7Response($policy, HttpMessageType::incomingResponse(), $response));

$childSpan->setStatus(SpanStatus::createFromHttpStatusCode($response->getStatusCode()));
$childSpan->setData($spanAndBreadcrumbData);
$childSpan->setData(array_merge($spanData, $childSpan->getData()));
} else {
$childSpan->setStatus(SpanStatus::internalError());
}
Expand All @@ -119,7 +144,7 @@ public static function trace(?HubInterface $hub = null): \Closure
'http',
null,
array_merge([
'url' => (string) $partialUri,
'url' => $breadcrumbUrl,
], $spanAndBreadcrumbData)
));

Expand All @@ -135,16 +160,43 @@ public static function trace(?HubInterface $hub = null): \Closure
};
}

private static function shouldAttachTracingHeaders(?ClientInterface $client, RequestInterface $request): bool
/**
* @param array<string, mixed> $data
* @param array<array-key, string[]>|null $headers
*/
private static function addHeaderData(array &$data, string $prefix, ?array $headers): void
{
if ($client === null) {
return false;
foreach ($headers ?? [] as $name => $values) {
$data[$prefix . '.' . strtolower((string) $name)] = $values;
}
}

/**
* @param array<string, mixed> $data
* @param array<array-key, mixed>|string|null $cookies Cookies grouped by name, or `[Filtered]` if they could not be parsed
*/
private static function addCookieData(array &$data, string $prefix, $cookies): void
{
if (\is_string($cookies)) {
$data[$prefix] = $cookies;

$sdkOptions = $client->getOptions();
return;
}

/** @mago-ignore analysis:mixed-assignment */
foreach ($cookies ?? [] as $name => $value) {
$data[$prefix . '.' . $name] = $value;
}
}

private static function shouldAttachTracingHeaders(?Options $options, RequestInterface $request): bool
{
if ($options === null) {
return false;
}

// Check if the request destination is allow listed in the trace_propagation_targets option.
return $sdkOptions->getTracePropagationTargets() === null
|| \in_array($request->getUri()->getHost(), $sdkOptions->getTracePropagationTargets());
return $options->getTracePropagationTargets() === null
|| \in_array($request->getUri()->getHost(), $options->getTracePropagationTargets());
}
}
Loading
Loading