TASK: Add log environment data to all logger calls

Author: daniellienert

Classes/Driver/Version5/IndexerDriver.php

@@ -19,6 +19,7 @@
 use Flowpack\ElasticSearch\Domain\Model\Document as ElasticSearchDocument;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Log\Utility\LogEnvironment;
 
 /**
  * Indexer driver for Elasticsearch version 5.x
@@ -96,12 +97,12 @@ public function fulltext(NodeInterface $node, array $fulltextIndexOfNode, string
 
         if ($closestFulltextNode->isRemoved()) {
             // fulltext root is removed, abort silently...
-            $this->logger->debug(sprintf('NodeIndexer (%s): Fulltext root found for %s (%s) not updated, it is removed', $closestFulltextNodeDocumentIdentifier, $node->getPath(), $node->getIdentifier()));
+            $this->logger->debug(sprintf('NodeIndexer (%s): Fulltext root found for %s (%s) not updated, it is removed', $closestFulltextNodeDocumentIdentifier, $node->getPath(), $node->getIdentifier()), LogEnvironment::fromMethodName(__METHOD__));
 
             return [];
         }
 
-        $this->logger->debug(sprintf('NodeIndexer (%s): Updated fulltext index for %s (%s)', $closestFulltextNodeDocumentIdentifier, $closestFulltextNodeContextPath, $closestFulltextNode->getIdentifier()));
+        $this->logger->debug(sprintf('NodeIndexer (%s): Updated fulltext index for %s (%s)', $closestFulltextNodeDocumentIdentifier, $closestFulltextNodeContextPath, $closestFulltextNode->getIdentifier()), LogEnvironment::fromMethodName(__METHOD__));
 
         $upsertFulltextParts = [];
         if (!empty($fulltextIndexOfNode)) {

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Eel;
@@ -19,6 +18,7 @@
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException;
+use Neos\Flow\Log\ThrowableStorageInterface;
 use Neos\Flow\Log\Utility\LogEnvironment;
 use Psr\Log\LoggerInterface;
 use Flowpack\ElasticSearch\Transfer\Exception\ApiException;
@@ -60,6 +60,12 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
      */
     protected $logger;
 
+    /**
+     * @Flow\Inject
+     * @var ThrowableStorageInterface
+     */
+    protected $throwableStorage;
+
     /**
      * @var boolean
      */
@@ -190,6 +196,7 @@ public function sort($configuration): ElasticSearchQueryBuilder
      *
      * @param integer $limit
      * @return ElasticSearchQueryBuilder
+     * @throws \Neos\Flow\Persistence\Exception\IllegalObjectTypeException
      * @api
      */
     public function limit($limit)
@@ -571,7 +578,9 @@ public function getFullElasticSearchHitForNode(NodeInterface $node): array
      * This method is rather internal; just to be called from the ElasticSearchQueryResult. For the public API, please use execute()
      *
      * @return array<\Neos\ContentRepository\Domain\Model\NodeInterface>
+     * @throws Exception
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     public function fetch(): array
     {
@@ -587,13 +596,13 @@ public function fetch(): array
 
             $this->result['nodes'] = [];
 
-            $this->logThisQuery && $this->logger->debug(sprintf('Query Log (%s): %s -- execution time: %s ms -- Limit: %s -- Number of results returned: %s -- Total Results: %s', $this->logMessage, $request, (($timeAfterwards - $timeBefore) * 1000), $this->limit, count($searchResult->getHits()), $searchResult->getTotal()));
+            $this->logThisQuery && $this->logger->debug(sprintf('Query Log (%s): %s -- execution time: %s ms -- Limit: %s -- Number of results returned: %s -- Total Results: %s', $this->logMessage, $request, (($timeAfterwards - $timeBefore) * 1000), $this->limit, count($searchResult->getHits()), $searchResult->getTotal()), LogEnvironment::fromMethodName(__METHOD__));
 
             if (count($searchResult->getHits()) > 0) {
                 $this->result['nodes'] = $this->convertHitsToNodes($searchResult->getHits());
             }
         } catch (ApiException $exception) {
-            $this->logger->logException($exception);
+            $this->throwableStorage->logThrowable($exception);
             $this->result['nodes'] = [];
         }
 
@@ -640,7 +649,9 @@ public function executeUncached(): ElasticSearchQueryResult
      * Return the total number of hits for the query.
      *
      * @return integer
+     * @throws Exception
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      * @api
      */
     public function count()
@@ -654,7 +665,7 @@ public function count()
         $treatedContent = $response->getTreatedContent();
         $count = $treatedContent['count'];
 
-        $this->logThisQuery && $this->logger->debug('Count Query Log (' . $this->logMessage . '): ' . $request . ' -- execution time: ' . (($timeAfterwards - $timeBefore) * 1000) . ' ms -- Total Results: ' . $count);
+        $this->logThisQuery && $this->logger->debug('Count Query Log (' . $this->logMessage . '): ' . $request . ' -- execution time: ' . (($timeAfterwards - $timeBefore) * 1000) . ' ms -- Total Results: ' . $count, LogEnvironment::fromMethodName(__METHOD__));
 
         return $count;
     }
@@ -866,8 +877,10 @@ protected function convertHitsToNodes(array $hits): array
      * hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the result.
      *
      * @return int
+     * @throws Exception
      * @throws QueryBuildingException
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     public function cacheLifetime(): int
     {
@@ -890,8 +903,10 @@ public function cacheLifetime(): int
     /**
      * @param string $dateField
      * @return int
+     * @throws Exception
      * @throws QueryBuildingException
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     protected function getNearestFutureDate(string $dateField): int
     {