TASK: Improve logging by showing the correct package key

Author: dfeyer

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/Command/NodeIndexQueueCommandController.php

@@ -2,10 +2,10 @@
 namespace Flowpack\ElasticSearch\ContentRepositoryQueueIndexer\Command;
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Indexer\NodeIndexer;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Mapping\NodeTypeMappingBuilder;
 use Flowpack\ElasticSearch\ContentRepositoryQueueIndexer\Domain\Repository\NodeDataRepository;
 use Flowpack\ElasticSearch\ContentRepositoryQueueIndexer\IndexingJob;
+use Flowpack\ElasticSearch\ContentRepositoryQueueIndexer\LoggerTrait;
 use Flowpack\ElasticSearch\ContentRepositoryQueueIndexer\UpdateAliasJob;
 use Flowpack\JobQueue\Common\Job\JobManager;
 use TYPO3\Flow\Annotations as Flow;
@@ -20,6 +20,8 @@
  */
 class NodeIndexQueueCommandController extends CommandController
 {
+    use LoggerTrait;
+
     /**
      * @Flow\Inject
      * @var JobManager
@@ -56,12 +58,6 @@ class NodeIndexQueueCommandController extends CommandController
      */
     protected $nodeIndexer;
 
-    /**
-     * @Flow\Inject
-     * @var LoggerInterface
-     */
-    protected $logger;
-
     /**
      * Index all nodes by creating a new index and when everything was completed, switch the index alias.
      *
@@ -137,7 +133,7 @@ protected function createNextIndex($indexPostfix)
     {
         $this->nodeIndexer->setIndexNamePostfix($indexPostfix);
         $this->nodeIndexer->getIndex()->create();
-        $this->logger->log(sprintf('action=indexing step=index-created index=%s', $this->nodeIndexer->getIndexName()), LOG_INFO);
+        $this->log(sprintf('action=indexing step=index-created index=%s', $this->nodeIndexer->getIndexName()), LOG_INFO);
     }
 
     /**
@@ -150,6 +146,6 @@ protected function updateMapping()
             /** @var \Flowpack\ElasticSearch\Domain\Model\Mapping $mapping */
             $mapping->apply();
         }
-        $this->logger->log(sprintf('action=indexing step=mapping-updated index=%s', $this->nodeIndexer->getIndexName()), LOG_INFO);
+        $this->log(sprintf('action=indexing step=mapping-updated index=%s', $this->nodeIndexer->getIndexName()), LOG_INFO);
     }
 }

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/IndexingJob.php

@@ -6,7 +6,6 @@
 use Flowpack\JobQueue\Common\Queue\Message;
 use Flowpack\JobQueue\Common\Queue\QueueInterface;
 use TYPO3\Flow\Annotations as Flow;
-use TYPO3\Flow\Log\SystemLoggerInterface;
 use TYPO3\Flow\Utility\Algorithms;
 use TYPO3\TYPO3CR\Domain\Factory\NodeFactory;
 use TYPO3\TYPO3CR\Domain\Model\NodeData;
@@ -19,6 +18,8 @@
  */
 class IndexingJob implements JobInterface
 {
+    use LoggerTrait;
+
     /**
      * @var NodeIndexer
      * @Flow\Inject
@@ -43,12 +44,6 @@ class IndexingJob implements JobInterface
      */
     protected $contextFactory;
 
-    /**
-     * @var SystemLoggerInterface
-     * @Flow\Inject
-     */
-    protected $logger;
-
     /**
      * @var string
      */
@@ -108,20 +103,20 @@ public function execute(QueueInterface $queue, Message $message)
 
                 // Skip this iteration if the node can not be fetched from the current context
                 if (!$currentNode instanceof NodeInterface) {
-                    $this->logger->log(sprintf('action=indexing step=failed node=%s message="Node could not be processed"', $node['nodeIdentifier']));
+                    $this->log(sprintf('action=indexing step=failed node=%s message="Node could not be processed"', $node['nodeIdentifier']));
                     continue;
                 }
 
                 $this->nodeIndexer->setIndexNamePostfix($this->indexPostfix);
-                $this->logger->log(sprintf('action=indexing step=started node=%s', $currentNode->getIdentifier()));
+                $this->log(sprintf('action=indexing step=started node=%s', $currentNode->getIdentifier()));
 
                 $this->nodeIndexer->indexNode($currentNode);
             }
 
             $this->nodeIndexer->flush();
             $duration = microtime(true) - $startTime;
             $rate = $numberOfNodes / $duration;
-            $this->logger->log(sprintf('action=indexing step=finished number_of_nodes=%d duration=%f nodes_per_second=%f', $numberOfNodes, $duration, $rate));
+            $this->log(sprintf('action=indexing step=finished number_of_nodes=%d duration=%f nodes_per_second=%f', $numberOfNodes, $duration, $rate));
         });
 
         return true;

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/LoggerTrait.php

@@ -0,0 +1,32 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentRepositoryQueueIndexer;
+
+use TYPO3\Flow\Annotations as Flow;
+
+/**
+ * LoggerTrait
+ */
+trait LoggerTrait
+{
+    /**
+     * @var \TYPO3\Flow\Log\SystemLoggerInterface
+     * @Flow\Inject
+     */
+    protected $_logger;
+
+    /**
+     * @param string $message The message to log
+     * @param integer $severity An integer value, one of the LOG_* constants
+     * @param mixed $additionalData A variable containing more information about the event to be logged
+     * @param string $packageKey Key of the package triggering the log (determined automatically if not specified)
+     * @param string $className Name of the class triggering the log (determined automatically if not specified)
+     * @param string $methodName Name of the method triggering the log (determined automatically if not specified)
+     * @return void
+     * @api
+     */
+    protected function log($message, $severity = LOG_INFO, $additionalData = null, $packageKey = null, $className = null, $methodName = null)
+    {
+        $packageKey = $packageKey ?: 'Flowpack.ElasticSearch.ContentRepositoryQueueIndexer';
+        $this->_logger->log($message, $severity, $additionalData, $packageKey, $className, $methodName);
+    }
+}

Classes/Flowpack/ElasticSearch/ContentRepositoryQueueIndexer/UpdateAliasJob.php

@@ -2,7 +2,6 @@
 namespace Flowpack\ElasticSearch\ContentRepositoryQueueIndexer;
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Indexer\NodeIndexer;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
 use Flowpack\JobQueue\Common\Job\JobInterface;
 use Flowpack\JobQueue\Common\Queue\Message;
 use Flowpack\JobQueue\Common\Queue\QueueInterface;
@@ -14,18 +13,14 @@
  */
 class UpdateAliasJob implements JobInterface
 {
+    use LoggerTrait;
+
     /**
      * @var NodeIndexer
      * @Flow\Inject
      */
     protected $nodeIndexer;
 
-    /**
-     * @var LoggerInterface
-     * @Flow\Inject
-     */
-    protected $logger;
-
     /**
      * @var string
      */
@@ -57,7 +52,7 @@ public function execute(QueueInterface $queue, Message $message)
     {
         $this->nodeIndexer->setIndexNamePostfix($this->indexPostfix);
         $this->nodeIndexer->updateIndexAlias();
-        $this->logger->log(sprintf('action=indexing step=index-switched alias=%s', $this->indexPostfix), LOG_NOTICE);
+        $this->log(sprintf('action=indexing step=index-switched alias=%s', $this->indexPostfix), LOG_NOTICE);
 
         return true;
     }