TracingRequestListener.php

<?php

declare(strict_types=1);

namespace Sentry\SentryBundle\EventListener;

use Sentry\Integration\RequestFetcherInterface;
use Sentry\SentryBundle\Integration\RequestFetcher;
use Sentry\State\HubInterface;
use Sentry\Tracing\TransactionSource;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\Event\TerminateEvent;

use function Sentry\continueTrace;
use function Sentry\metrics;

/**
 * This event listener acts on the master requests and starts a transaction
 * to report performance data to Sentry. It gathers useful data like the
 * HTTP status code of the response or the name of the route that handles
 * the request and add them as tags.
 */
final class TracingRequestListener extends AbstractTracingRequestListener
{
    /**
     * @var RequestFetcherInterface|null
     */
    private $requestFetcher;

    public function __construct(HubInterface $hub, ?RequestFetcherInterface $requestFetcher = null)
    {
        parent::__construct($hub);

        $this->requestFetcher = $requestFetcher;
    }

    /**
     * This method is called for each subrequest handled by the framework and
     * starts a new {@see Transaction}.
     *
     * @param RequestEvent $event The event
     */
    public function handleKernelRequestEvent(RequestEvent $event): void
    {
        if (!$this->isMainRequest($event)) {
            return;
        }

        /** @var Request $request */
        $request = $event->getRequest();

        if ($this->requestFetcher instanceof RequestFetcher) {
            $this->requestFetcher->setRequest($request);
        }

        /** @var float $requestStartTime */
        $requestStartTime = $request->server->get('REQUEST_TIME_FLOAT', microtime(true));

        $context = continueTrace(
            $request->headers->get('sentry-trace') ?? $request->headers->get('traceparent', ''),
            $request->headers->get('baggage', '')
        );

        $context->setOp('http.server');
        $context->setOrigin('auto.http.server');

        $routeName = $request->attributes->get('_route');
        if (null !== $routeName && \is_string($routeName)) {
            $context->setName(\sprintf('%s %s', $request->getMethod(), $routeName));
            $context->setSource(TransactionSource::route());
        } else {
            $context->setName(\sprintf('%s %s%s%s', $request->getMethod(), $request->getSchemeAndHttpHost(), $request->getBaseUrl(), $request->getPathInfo()));
            $context->setSource(TransactionSource::url());
        }

        $context->setStartTimestamp($requestStartTime);
        $context->setData($this->getData($request));

        $this->hub->setSpan($this->hub->startTransaction($context));
    }

    /**
     * This method is called for each request handled by the framework and
     * ends the tracing on terminate after the client received the response.
     *
     * @param TerminateEvent $event The event
     */
    public function handleKernelTerminateEvent(TerminateEvent $event): void
    {
        $transaction = $this->hub->getTransaction();

        if (null === $transaction) {
            return;
        }

        $transaction->finish();
        metrics()->flush();

        if ($this->requestFetcher instanceof RequestFetcher) {
            $this->requestFetcher->setRequest(null);
        }
    }

    /**
     * Gets the data to attach to the transaction.
     *
     * @param Request $request The HTTP request
     *
     * @return array<string, string>
     */
    private function getData(Request $request): array
    {
        $client = $this->hub->getClient();
        $httpFlavor = $this->getHttpFlavor($request);

        $data = [
            'net.host.port' => (string) $request->getPort(),
            'http.request.method' => $request->getMethod(),
            'http.url' => $request->getUri(),
            'route' => $this->getRouteName($request),
        ];

        if (null !== $httpFlavor) {
            $data['http.flavor'] = $httpFlavor;
        }

        if (false !== filter_var($request->getHost(), \FILTER_VALIDATE_IP)) {
            $data['net.host.ip'] = $request->getHost();
        } else {
            $data['net.host.name'] = $request->getHost();
        }

        if (null !== $request->getClientIp() && null !== $client && $client->getOptions()->shouldSendDefaultPii()) {
            $data['net.peer.ip'] = $request->getClientIp();
        }

        return $data;
    }

    /**
     * Gets the HTTP flavor from the request.
     *
     * @param Request $request The HTTP request
     */
    private function getHttpFlavor(Request $request): ?string
    {
        $protocolVersion = $request->getProtocolVersion();

        if (null !== $protocolVersion && str_starts_with($protocolVersion, 'HTTP/')) {
            return substr($protocolVersion, \strlen('HTTP/'));
        }

        return $protocolVersion;
    }
}