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

  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\Tracing\TransactionSource;
  8. use Symfony\Component\HttpFoundation\Request;
  9. use Symfony\Component\HttpKernel\Event\RequestEvent;
  10. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  12. use function Sentry\continueTrace;
  14. /**
  15.  * This event listener acts on the master requests and starts a transaction
  16.  * to report performance data to Sentry. It gathers useful data like the
  17.  * HTTP status code of the response or the name of the route that handles
  18.  * the request and add them as tags.
  19.  */
  20. final class TracingRequestListener extends AbstractTracingRequestListener
  21. {
  22.     /**
  23.      * This method is called for each subrequest handled by the framework and
  24.      * starts a new {@see Transaction}.
  25.      *
  26.      * @param RequestEvent $event The event
  27.      */
  28.     public function handleKernelRequestEvent(RequestEvent $event): void
  29.     {
  30.         if (!$this->isMainRequest($event)) {
  31.             return;
  32.         }
  34.         /** @var Request $request */
  35.         $request = $event->getRequest();
  37.         /** @var float $requestStartTime */
  38.         $requestStartTime = $request->server->get('REQUEST_TIME_FLOAT', microtime(true));
  40.         $context = continueTrace(
  41.             $request->headers->get('sentry-trace', ''),
  42.             $request->headers->get('baggage', '')
  43.         );
  44.         $context->setOp('http.server');
  46.         $routeName = $request->attributes->get('_route');
  47.         if (null !== $routeName && \is_string($routeName)) {
  48.             $context->setName(sprintf('%s %s', $request->getMethod(), $routeName));
  49.             $context->setSource(TransactionSource::route());
  50.         } else {
  51.             $context->setName(sprintf('%s %s%s%s', $request->getMethod(), $request->getSchemeAndHttpHost(), $request->getBaseUrl(), $request->getPathInfo()));
  52.             $context->setSource(TransactionSource::url());
  53.         }
  55.         $context->setStartTimestamp($requestStartTime);
  56.         $context->setData($this->getData($request));
  58.         $this->hub->setSpan($this->hub->startTransaction($context));
  59.     }
  61.     /**
  62.      * This method is called for each request handled by the framework and
  63.      * ends the tracing on terminate after the client received the response.
  64.      *
  65.      * @param TerminateEvent $event The event
  66.      */
  67.     public function handleKernelTerminateEvent(TerminateEvent $event): void
  68.     {
  69.         $transaction = $this->hub->getTransaction();
  71.         if (null === $transaction) {
  72.             return;
  73.         }
  75.         $transaction->finish();
  76.     }
  78.     /**
  79.      * Gets the data to attach to the transaction.
  80.      *
  81.      * @param Request $request The HTTP request
  82.      *
  83.      * @return array<string, string>
  84.      */
  85.     private function getData(Request $request): array
  86.     {
  87.         $client = $this->hub->getClient();
  88.         $httpFlavor = $this->getHttpFlavor($request);
  89.         $tags = [
  90.             'net.host.port' => (string) $request->getPort(),
  91.             'http.request.method' => $request->getMethod(),
  92.             'http.url' => $request->getUri(),
  93.             'route' => $this->getRouteName($request),
  94.         ];
  96.         if (null !== $httpFlavor) {
  97.             $tags['http.flavor'] = $httpFlavor;
  98.         }
  100.         if (false !== filter_var($request->getHost(), \FILTER_VALIDATE_IP)) {
  101.             $tags['net.host.ip'] = $request->getHost();
  102.         } else {
  103.             $tags['net.host.name'] = $request->getHost();
  104.         }
  106.         if (null !== $request->getClientIp() && null !== $client && $client->getOptions()->shouldSendDefaultPii()) {
  107.             $tags['net.peer.ip'] = $request->getClientIp();
  108.         }
  110.         return $tags;
  111.     }
  113.     /**
  114.      * Gets the HTTP flavor from the request.
  115.      *
  116.      * @param Request $request The HTTP request
  117.      */
  118.     private function getHttpFlavor(Request $request): ?string
  119.     {
  120.         $protocolVersion = $request->getProtocolVersion();
  122.         if (null !== $protocolVersion && str_starts_with($protocolVersion, 'HTTP/')) {
  123.             return substr($protocolVersion, \strlen('HTTP/'));
  124.         }
  126.         return $protocolVersion;
  127.     }
  128. }