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

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