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

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;
  11. use Symfony\Component\HttpKernel\Event\RequestEvent;
  12. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  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 = TransactionContext::fromHeaders(
  41.             $request->headers->get('sentry-trace', ''),
  42.             $request->headers->get('baggage', '')
  43.         );
  44.         $context->setOp('http.server');
  45.         $context->setName(sprintf('%s %s%s%s', $request->getMethod(), $request->getSchemeAndHttpHost(), $request->getBaseUrl(), $request->getPathInfo()));
  46.         $context->setSource(TransactionSource::url());
  47.         $context->setStartTimestamp($requestStartTime);
  48.         $context->setTags($this->getTags($request));
  50.         $this->hub->setSpan($this->hub->startTransaction($context));
  51.     }
  53.     /**
  54.      * This method is called for each request handled by the framework and
  55.      * ends the tracing on terminate after the client received the response.
  56.      *
  57.      * @param TerminateEvent $event The event
  58.      */
  59.     public function handleKernelTerminateEvent(TerminateEvent $event): void
  60.     {
  61.         $transaction = $this->hub->getTransaction();
  63.         if (null === $transaction) {
  64.             return;
  65.         }
  67.         $transaction->finish();
  68.     }
  70.     /**
  71.      * Gets the tags to attach to the transaction.
  72.      *
  73.      * @param Request $request The HTTP request
  74.      *
  75.      * @return array<string, string>
  76.      */
  77.     private function getTags(Request $request): array
  78.     {
  79.         $client = $this->hub->getClient();
  80.         $httpFlavor = $this->getHttpFlavor($request);
  81.         $tags = [
  82.             'net.host.port' => (string) $request->getPort(),
  83.             'http.method' => $request->getMethod(),
  84.             'http.url' => $request->getUri(),
  85.             'route' => $this->getRouteName($request),
  86.         ];
  88.         if (null !== $httpFlavor) {
  89.             $tags['http.flavor'] = $httpFlavor;
  90.         }
  92.         if (false !== filter_var($request->getHost(), \FILTER_VALIDATE_IP)) {
  93.             $tags['net.host.ip'] = $request->getHost();
  94.         } else {
  95.             $tags['net.host.name'] = $request->getHost();
  96.         }
  98.         if (null !== $request->getClientIp() && null !== $client && $client->getOptions()->shouldSendDefaultPii()) {
  99.             $tags['net.peer.ip'] = $request->getClientIp();
  100.         }
  102.         return $tags;
  103.     }
  105.     /**
  106.      * Gets the HTTP flavor from the request.
  107.      *
  108.      * @param Request $request The HTTP request
  109.      */
  110.     private function getHttpFlavor(Request $request): ?string
  111.     {
  112.         $protocolVersion = $request->getProtocolVersion();
  114.         if (null !== $protocolVersion && str_starts_with($protocolVersion, 'HTTP/')) {
  115.             return substr($protocolVersion, \strlen('HTTP/'));
  116.         }
  118.         return $protocolVersion;
  119.     }
  120. }