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

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 Symfony\Component\HttpFoundation\Request;
  11. /**
  12.  * This event listener acts on the master requests and starts a transaction
  13.  * to report performance data to Sentry. It gathers useful data like the
  14.  * HTTP status code of the response or the name of the route that handles
  15.  * the request and add them as tags.
  16.  */
  17. final class TracingRequestListener extends AbstractTracingRequestListener
  18. {
  19.     /**
  20.      * This method is called for each subrequest handled by the framework and
  21.      * starts a new {@see Transaction}.
  22.      *
  23.      * @param RequestListenerRequestEvent $event The event
  24.      */
  25.     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
  26.     {
  27.         if (!$this->isMainRequest($event)) {
  28.             return;
  29.         }
  31.         /** @var Request $request */
  32.         $request = $event->getRequest();
  34.         /** @var float $requestStartTime */
  35.         $requestStartTime = $request->server->get('REQUEST_TIME_FLOAT', microtime(true));
  37.         $context = TransactionContext::fromSentryTrace($request->headers->get('sentry-trace', ''));
  38.         $context->setOp('http.server');
  39.         $context->setName(sprintf('%s %s%s%s', $request->getMethod(), $request->getSchemeAndHttpHost(), $request->getBaseUrl(), $request->getPathInfo()));
  40.         $context->setStartTimestamp($requestStartTime);
  41.         $context->setTags($this->getTags($request));
  43.         $this->hub->setSpan($this->hub->startTransaction($context));
  44.     }
  46.     /**
  47.      * This method is called for each request handled by the framework and
  48.      * ends the tracing on terminate after the client received the response.
  49.      *
  50.      * @param RequestListenerTerminateEvent $event The event
  51.      */
  52.     public function handleKernelTerminateEvent(RequestListenerTerminateEvent $event): void
  53.     {
  54.         $transaction = $this->hub->getTransaction();
  56.         if (null === $transaction) {
  57.             return;
  58.         }
  60.         $transaction->finish();
  61.     }
  63.     /**
  64.      * Gets the tags to attach to the transaction.
  65.      *
  66.      * @param Request $request The HTTP request
  67.      *
  68.      * @return array<string, string>
  69.      */
  70.     private function getTags(Request $request): array
  71.     {
  72.         $client = $this->hub->getClient();
  73.         $httpFlavor = $this->getHttpFlavor($request);
  74.         $tags = [
  75.             'net.host.port' => (string) $request->getPort(),
  76.             'http.method' => $request->getMethod(),
  77.             'http.url' => $request->getUri(),
  78.             'route' => $this->getRouteName($request),
  79.         ];
  81.         if (null !== $httpFlavor) {
  82.             $tags['http.flavor'] = $httpFlavor;
  83.         }
  85.         if (false !== filter_var($request->getHost(), \FILTER_VALIDATE_IP)) {
  86.             $tags['net.host.ip'] = $request->getHost();
  87.         } else {
  88.             $tags['net.host.name'] = $request->getHost();
  89.         }
  91.         if (null !== $request->getClientIp() && null !== $client && $client->getOptions()->shouldSendDefaultPii()) {
  92.             $tags['net.peer.ip'] = $request->getClientIp();
  93.         }
  95.         return $tags;
  96.     }
  98.     /**
  99.      * Gets the HTTP flavor from the request.
  100.      *
  101.      * @param Request $request The HTTP request
  102.      */
  103.     private function getHttpFlavor(Request $request): ?string
  104.     {
  105.         $protocolVersion = $request->getProtocolVersion();
  107.         if (null !== $protocolVersion && str_starts_with($protocolVersion, 'HTTP/')) {
  108.             return substr($protocolVersion, \strlen('HTTP/'));
  109.         }
  111.         return $protocolVersion;
  112.     }
  113. }