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

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