vendor/friendsofsymfony/elastica-bundle/src/Elastica/Client.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSElasticaBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\ElasticaBundle\Elastica;
  14. use Elastica\Client as BaseClient;
  15. use Elastica\Exception\ClientException;
  16. use Elastica\Request;
  17. use FOS\ElasticaBundle\Logger\ElasticaLogger;
  18. use Symfony\Component\Stopwatch\Stopwatch;
  20. /**
  21.  * Extends the default Elastica client to provide logging for errors that occur
  22.  * during communication with ElasticSearch.
  23.  *
  24.  * @author Gordon Franke <info@nevalon.de>
  25.  */
  26. class Client extends BaseClient
  27. {
  28.     /**
  29.      * Stores created indexes to avoid recreation.
  30.      *
  31.      * @var array
  32.      */
  33.     private $indexCache = [];
  35.     /**
  36.      * Stores created index template to avoid recreation.
  37.      *
  38.      * @var array
  39.      */
  40.     private $indexTemplateCache = array();
  42.     /**
  43.      * Symfony's debugging Stopwatch.
  44.      *
  45.      * @var Stopwatch|null
  46.      */
  47.     private $stopwatch;
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function request($path, $method = Request::GET, $data = [], array $query = [], $contentType = Request::DEFAULT_CONTENT_TYPE)
  53.     {
  54.         if ($this->stopwatch) {
  55.             $this->stopwatch->start('es_request', 'fos_elastica');
  56.         }
  58.         $response = parent::request($path, $method, $data, $query, $contentType);
  59.         $responseData = $response->getData();
  61.         $transportInfo = $response->getTransferInfo();
  62.         $connection = $this->getLastRequest()->getConnection();
  63.         $forbiddenHttpCodes = $connection->hasConfig('http_error_codes') ? $connection->getConfig('http_error_codes') : [];
  65.         if (isset($transportInfo['http_code']) && in_array($transportInfo['http_code'], $forbiddenHttpCodes, true)) {
  66.             $body = is_array($responseData) ? json_encode($responseData) : $responseData;
  67.             $message = sprintf('Error in transportInfo: response code is %s, response body is %s', $transportInfo['http_code'], $body);
  68.             throw new ClientException($message);
  69.         }
  71.         if (isset($responseData['took']) && isset($responseData['hits'])) {
  72.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), $response->getEngineTime(), $responseData['hits']['total']);
  73.         } else {
  74.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), 0, 0);
  75.         }
  77.         if ($this->stopwatch) {
  78.             $this->stopwatch->stop('es_request');
  79.         }
  81.         return $response;
  82.     }
  84.     /**
  85.      * @param string $name
  86.      *
  87.      * @return Index|mixed
  88.      */
  89.     public function getIndex($name)
  90.     {
  91.         if (isset($this->indexCache[$name])) {
  92.             return $this->indexCache[$name];
  93.         }
  95.         return $this->indexCache[$name] = new Index($this, $name);
  96.     }
  98.     public function getIndexTemplate($name)
  99.     {
  100.         if (isset($this->indexTemplateCache[$name])) {
  101.             return $this->indexTemplateCache[$name];
  102.         }
  104.         return $this->indexTemplateCache[$name] = new IndexTemplate($this, $name);
  105.     }
  107.     /**
  108.      * Sets a stopwatch instance for debugging purposes.
  109.      *
  110.      * @param Stopwatch $stopwatch
  111.      */
  112.     public function setStopwatch(Stopwatch $stopwatch = null)
  113.     {
  114.         $this->stopwatch = $stopwatch;
  115.     }
  117.     /**
  118.      * Log the query if we have an instance of ElasticaLogger.
  119.      *
  120.      * @param string $path
  121.      * @param string $method
  122.      * @param array|string $data
  123.      * @param array  $query
  124.      * @param int    $queryTime
  125.      * @param int    $engineMS
  126.      * @param int    $itemCount
  127.      */
  128.     private function logQuery($path, $method, $data, array $query, $queryTime, $engineMS = 0, $itemCount = 0)
  129.     {
  130.         if (!$this->_logger or !$this->_logger instanceof ElasticaLogger) {
  131.             return;
  132.         }
  134.         $connection = $this->getLastRequest()->getConnection();
  136.         $connectionArray = [
  137.             'host' => $connection->getHost(),
  138.             'port' => $connection->getPort(),
  139.             'transport' => $connection->getTransport(),
  140.             'headers' => $connection->hasConfig('headers') ? $connection->getConfig('headers') : [],
  141.         ];
  143.         /** @var ElasticaLogger $logger */
  144.         $logger = $this->_logger;
  145.         $logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
  146.     }
  147. }