vendor/ekino/newrelic-bundle/Listener/RequestListener.php line 61

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Ekino New Relic bundle.
  7.  *
  8.  * (c) Ekino - Thomas Rabaix <thomas.rabaix@ekino.com>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Ekino\NewRelicBundle\Listener;
  16. use Ekino\NewRelicBundle\NewRelic\Config;
  17. use Ekino\NewRelicBundle\NewRelic\NewRelicInteractorInterface;
  18. use Ekino\NewRelicBundle\TransactionNamingStrategy\TransactionNamingStrategyInterface;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  21. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. use Symfony\Component\HttpKernel\HttpKernelInterface;
  23. use Symfony\Component\HttpKernel\KernelEvents;
  25. class RequestListener implements EventSubscriberInterface
  26. {
  27.     private $ignoredRoutes;
  28.     private $ignoredPaths;
  29.     private $config;
  30.     private $interactor;
  31.     private $transactionNamingStrategy;
  32.     private $symfonyCache;
  34.     public function __construct(
  35.         Config $config,
  36.         NewRelicInteractorInterface $interactor,
  37.         array $ignoreRoutes,
  38.         array $ignoredPaths,
  39.         TransactionNamingStrategyInterface $transactionNamingStrategy,
  40.         bool $symfonyCache = false
  41.     ) {
  42.         $this->config = $config;
  43.         $this->interactor = $interactor;
  44.         $this->ignoredRoutes = $ignoreRoutes;
  45.         $this->ignoredPaths = $ignoredPaths;
  46.         $this->transactionNamingStrategy = $transactionNamingStrategy;
  47.         $this->symfonyCache = $symfonyCache;
  48.     }
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             KernelEvents::REQUEST => [
  54.                  ['setApplicationName', 255],
  55.                  ['setIgnoreTransaction', 31],
  56.                  ['setTransactionName', -10],
  57.             ],
  58.         ];
  59.     }
  61.     public function setApplicationName(KernelRequestEvent $event): void
  62.     {
  63.         if (!$this->isEventValid($event)) {
  64.             return;
  65.         }
  67.         $appName = $this->config->getName();
  69.         if (!$appName) {
  70.             return;
  71.         }
  73.         if ($this->symfonyCache) {
  74.             $this->interactor->startTransaction($appName);
  75.         }
  77.         // Set application name if different from ini configuration
  78.         if ($appName !== ini_get('newrelic.appname')) {
  79.             $this->interactor->setApplicationName($appName, $this->config->getLicenseKey(), $this->config->getXmit());
  80.         }
  81.     }
  83.     public function setTransactionName(KernelRequestEvent $event): void
  84.     {
  85.         if (!$this->isEventValid($event)) {
  86.             return;
  87.         }
  89.         $transactionName = $this->transactionNamingStrategy->getTransactionName($event->getRequest());
  91.         $this->interactor->setTransactionName($transactionName);
  92.     }
  94.     public function setIgnoreTransaction(KernelRequestEvent $event): void
  95.     {
  96.         if (!$this->isEventValid($event)) {
  97.             return;
  98.         }
  100.         $request = $event->getRequest();
  101.         if (\in_array($request->get('_route'), $this->ignoredRoutes, true)) {
  102.             $this->interactor->ignoreTransaction();
  103.         }
  105.         if (\in_array($request->getPathInfo(), $this->ignoredPaths, true)) {
  106.             $this->interactor->ignoreTransaction();
  107.         }
  108.     }
  110.     /**
  111.      * Make sure we should consider this event. Example: make sure it is a master request.
  112.      */
  113.     private function isEventValid(KernelRequestEvent $event): bool
  114.     {
  115.         return HttpKernelInterface::MASTER_REQUEST === $event->getRequestType();
  116.     }
  117. }
  119. if (!class_exists(KernelRequestEvent::class)) {
  120.     if (class_exists(RequestEvent::class)) {
  121.         class_alias(RequestEvent::class, KernelRequestEvent::class);
  122.     } else {
  123.         class_alias(GetResponseEvent::class, KernelRequestEvent::class);
  124.     }
  125. }