vendor/sentry/sentry-symfony/src/EventListener/TracingRequestListener.php line 89

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\Integration\RequestFetcherInterface;
  8. use Sentry\SentryBundle\Integration\RequestFetcher;
  9. use Sentry\State\HubInterface;
  10. use Sentry\Tracing\TransactionSource;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpKernel\Event\RequestEvent;
  13. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  15. use function Sentry\continueTrace;
  16. use function Sentry\metrics;
  18. /**
  19.  * This event listener acts on the master requests and starts a transaction
  20.  * to report performance data to Sentry. It gathers useful data like the
  21.  * HTTP status code of the response or the name of the route that handles
  22.  * the request and add them as tags.
  23.  */
  24. final class TracingRequestListener extends AbstractTracingRequestListener
  25. {
  26.     /**
  27.      * @var RequestFetcherInterface|null
  28.      */
  29.     private $requestFetcher;
  31.     public function __construct(HubInterface $hub, ?RequestFetcherInterface $requestFetcher = null)
  32.     {
  33.         parent::__construct($hub);
  35.         $this->requestFetcher = $requestFetcher;
  36.     }
  38.     /**
  39.      * This method is called for each subrequest handled by the framework and
  40.      * starts a new {@see Transaction}.
  41.      *
  42.      * @param RequestEvent $event The event
  43.      */
  44.     public function handleKernelRequestEvent(RequestEvent $event): void
  45.     {
  46.         if (!$this->isMainRequest($event)) {
  47.             return;
  48.         }
  50.         /** @var Request $request */
  51.         $request = $event->getRequest();
  53.         if ($this->requestFetcher instanceof RequestFetcher) {
  54.             $this->requestFetcher->setRequest($request);
  55.         }
  57.         /** @var float $requestStartTime */
  58.         $requestStartTime = $request->server->get('REQUEST_TIME_FLOAT', microtime(true));
  60.         $context = continueTrace(
  61.             $request->headers->get('sentry-trace') ?? $request->headers->get('traceparent', ''),
  62.             $request->headers->get('baggage', '')
  63.         );
  65.         $context->setOp('http.server');
  66.         $context->setOrigin('auto.http.server');
  68.         $routeName = $request->attributes->get('_route');
  69.         if (null !== $routeName && \is_string($routeName)) {
  70.             $context->setName(\sprintf('%s %s', $request->getMethod(), $routeName));
  71.             $context->setSource(TransactionSource::route());
  72.         } else {
  73.             $context->setName(\sprintf('%s %s%s%s', $request->getMethod(), $request->getSchemeAndHttpHost(), $request->getBaseUrl(), $request->getPathInfo()));
  74.             $context->setSource(TransactionSource::url());
  75.         }
  77.         $context->setStartTimestamp($requestStartTime);
  78.         $context->setData($this->getData($request));
  80.         $this->hub->setSpan($this->hub->startTransaction($context));
  81.     }
  83.     /**
  84.      * This method is called for each request handled by the framework and
  85.      * ends the tracing on terminate after the client received the response.
  86.      *
  87.      * @param TerminateEvent $event The event
  88.      */
  89.     public function handleKernelTerminateEvent(TerminateEvent $event): void
  90.     {
  91.         $transaction = $this->hub->getTransaction();
  93.         if (null === $transaction) {
  94.             return;
  95.         }
  97.         $transaction->finish();
  98.         metrics()->flush();
  100.         if ($this->requestFetcher instanceof RequestFetcher) {
  101.             $this->requestFetcher->setRequest(null);
  102.         }
  103.     }
  105.     /**
  106.      * Gets the data to attach to the transaction.
  107.      *
  108.      * @param Request $request The HTTP request
  109.      *
  110.      * @return array<string, string>
  111.      */
  112.     private function getData(Request $request): array
  113.     {
  114.         $client = $this->hub->getClient();
  115.         $httpFlavor = $this->getHttpFlavor($request);
  117.         $data = [
  118.             'net.host.port' => (string) $request->getPort(),
  119.             'http.request.method' => $request->getMethod(),
  120.             'http.url' => $request->getUri(),
  121.             'route' => $this->getRouteName($request),
  122.         ];
  124.         if (null !== $httpFlavor) {
  125.             $data['http.flavor'] = $httpFlavor;
  126.         }
  128.         if (false !== filter_var($request->getHost(), \FILTER_VALIDATE_IP)) {
  129.             $data['net.host.ip'] = $request->getHost();
  130.         } else {
  131.             $data['net.host.name'] = $request->getHost();
  132.         }
  134.         if (null !== $request->getClientIp() && null !== $client && $client->getOptions()->shouldSendDefaultPii()) {
  135.             $data['net.peer.ip'] = $request->getClientIp();
  136.         }
  138.         return $data;
  139.     }
  141.     /**
  142.      * Gets the HTTP flavor from the request.
  143.      *
  144.      * @param Request $request The HTTP request
  145.      */
  146.     private function getHttpFlavor(Request $request): ?string
  147.     {
  148.         $protocolVersion = $request->getProtocolVersion();
  150.         if (null !== $protocolVersion && str_starts_with($protocolVersion, 'HTTP/')) {
  151.             return substr($protocolVersion, \strlen('HTTP/'));
  152.         }
  154.         return $protocolVersion;
  155.     }
  156. }