vendor/nelmio/solarium-bundle/src/Logger.php line 122

  1. <?php
  3. namespace Nelmio\SolariumBundle;
  5. use Psr\Log\LoggerInterface;
  6. use Solarium\Core\Client\Request as SolariumRequest;
  7. use Solarium\Core\Client\Endpoint as SolariumEndpoint;
  8. use Solarium\Core\Plugin\AbstractPlugin as SolariumPlugin;
  9. use Solarium\Core\Event\Events as SolariumEvents;
  10. use Solarium\Core\Event\PreExecuteRequest as SolariumPreExecuteRequestEvent;
  11. use Solarium\Core\Event\PostExecuteRequest as SolariumPostExecuteRequestEvent;
  12. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  13. use Symfony\Component\HttpFoundation\Request as HttpRequest;
  14. use Symfony\Component\HttpFoundation\Response as HttpResponse;
  15. use Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface;
  16. use Symfony\Component\Stopwatch\Stopwatch;
  18. class Logger extends SolariumPlugin implements DataCollectorInterface, \Serializable
  19. {
  20.     private $data = array();
  21.     private $queries = array();
  22.     private $currentRequest;
  23.     private $currentStartTime;
  24.     private $currentEndpoint;
  26.     private $logger;
  27.     private $stopwatch;
  28.     private $eventDispatchers = array();
  30.     /**
  31.      * Plugin init function
  32.      *
  33.      * Register event listeners
  34.      */
  35.     protected function initPluginType()
  36.     {
  37.         $dispatcher = $this->client->getEventDispatcher();
  38.         if (!in_array($dispatcher, $this->eventDispatchers, true)) {
  39.             if ($dispatcher instanceof EventDispatcherInterface) {
  40.                 $dispatcher->addListener(SolariumEvents::PRE_EXECUTE_REQUEST, array($this, 'preExecuteRequest'), 1000);
  41.                 $dispatcher->addListener(SolariumEvents::POST_EXECUTE_REQUEST, array($this, 'postExecuteRequest'), -1000);
  42.             }
  43.             $this->eventDispatchers[] = $dispatcher;
  44.         }
  45.     }
  47.     public function setLogger(LoggerInterface $logger)
  48.     {
  49.         $this->logger = $logger;
  50.     }
  52.     public function setStopwatch(Stopwatch $stopwatch)
  53.     {
  54.         $this->stopwatch = $stopwatch;
  55.     }
  57.     public function log(SolariumRequest $request, $response, SolariumEndpoint $endpoint, $duration)
  58.     {
  59.         $this->queries[] = array(
  60.             'request' => $request,
  61.             'response' => $response,
  62.             'duration' => $duration,
  63.             'base_uri' => $this->getEndpointBaseUrl($endpoint),
  64.         );
  65.     }
  67.     public function collect(HttpRequest $request, HttpResponse $response, /** \Throwable */ $exception = null)
  68.     {
  69.         if (isset($this->currentRequest)) {
  70.             $this->failCurrentRequest();
  71.         }
  73.         $time = 0;
  74.         foreach ($this->queries as $queryStruct) {
  75.             $time += $queryStruct['duration'];
  76.         }
  77.         $this->data = array(
  78.             'queries'     => $this->queries,
  79.             'total_time'  => $time,
  80.         );
  81.     }
  83.     public function getName(): string
  84.     {
  85.         return 'solr';
  86.     }
  88.     public function getQueries()
  89.     {
  90.         return array_key_exists('queries', $this->data) ? $this->data['queries'] : array();
  91.     }
  93.     public function getQueryCount()
  94.     {
  95.         return count($this->getQueries());
  96.     }
  98.     public function getTotalTime()
  99.     {
  100.         return array_key_exists('total_time', $this->data) ? $this->data['total_time'] : 0;
  101.     }
  103.     public function preExecuteRequest(SolariumPreExecuteRequestEvent $event)
  104.     {
  105.         if (isset($this->currentRequest)) {
  106.             $this->failCurrentRequest();
  107.         }
  109.         if (null !== $this->stopwatch) {
  110.             $this->stopwatch->start('solr', 'solr');
  111.         }
  113.         $this->currentRequest = $event->getRequest();
  114.         $this->currentEndpoint = $event->getEndpoint();
  116.         if (null !== $this->logger) {
  117.             $this->logger->debug($this->getEndpointBaseUrl($this->currentEndpoint) . $this->currentRequest->getUri());
  118.         }
  119.         $this->currentStartTime = microtime(true);
  120.     }
  122.     public function postExecuteRequest(SolariumPostExecuteRequestEvent $event)
  123.     {
  124.         $endTime = microtime(true) - $this->currentStartTime;
  125.         if (!isset($this->currentRequest)) {
  126.             throw new \RuntimeException('Request not set');
  127.         }
  128.         if ($this->currentRequest !== $event->getRequest()) {
  129.             throw new \RuntimeException('Requests differ');
  130.         }
  132.         if (null !== $this->stopwatch && $this->stopwatch->isStarted('solr')) {
  133.             $this->stopwatch->stop('solr');
  134.         }
  136.         $this->log($event->getRequest(), $event->getResponse(), $event->getEndpoint(), $endTime);
  138.         $this->currentRequest = null;
  139.         $this->currentStartTime = null;
  140.         $this->currentEndpoint = null;
  141.     }
  143.     public function failCurrentRequest()
  144.     {
  145.         $endTime = microtime(true) - $this->currentStartTime;
  147.         if (null !== $this->stopwatch && $this->stopwatch->isStarted('solr')) {
  148.             $this->stopwatch->stop('solr');
  149.         }
  151.         $this->log($this->currentRequest, null, $this->currentEndpoint, $endTime);
  153.         $this->currentRequest = null;
  154.         $this->currentStartTime = null;
  155.         $this->currentEndpoint = null;
  156.     }
  158.     public function serialize()
  159.     {
  160.         return serialize($this->data);
  161.     }
  163.     public function unserialize($data)
  164.     {
  165.         $this->data = unserialize($data);
  166.     }
  168.     public function reset()
  169.     {
  170.         $this->data = array();
  171.         $this->queries = array();
  172.     }
  174.     public function __serialize(): array
  175.     {
  176.         return $this->data;
  177.     }
  179.     public function __unserialize(array $data): void
  180.     {
  181.         $this->data = $data;
  182.     }
  184.     private function getEndpointBaseUrl(SolariumEndpoint $endpoint): string
  185.     {
  186.         // Support for Solarium v4.2: getBaseUri() has been deprecated in favor of getCoreBaseUri()
  187.         return method_exists($endpoint, 'getCoreBaseUri') ? $endpoint->getCoreBaseUri() : $endpoint->getBaseUri();
  188.     }
  189. }