FEATURE: Add statistics event logging to ContentReleaseLogger

Author: sachera

Classes/BackendUi/BackendUiDataService.php

@@ -14,6 +14,7 @@
 use Flowpack\DecoupledContentStore\NodeRendering\Dto\RenderingStatistics;
 use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingErrorManager;
 use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingStatisticsStore;
+use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingTimeStatisticsStore;
 use Flowpack\DecoupledContentStore\PrepareContentRelease\Dto\ContentReleaseMetadata;
 use Flowpack\DecoupledContentStore\PrepareContentRelease\Infrastructure\RedisContentReleaseService;
 use Flowpack\DecoupledContentStore\ReleaseSwitch\Infrastructure\RedisReleaseSwitchService;
@@ -45,7 +46,7 @@ class BackendUiDataService
 
     /**
      * @Flow\Inject
-     * @var RedisRenderingStatisticsStore
+     * @var RedisRenderingTimeStatisticsStore
      */
     protected $redisRenderingStatisticsStore;
 

Classes/Core/Infrastructure/ConsoleStatisticsEventOutput.php

@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\Core\Infrastructure;
+
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\ContentReleaseIdentifier;
+use Neos\Flow\Cli\ConsoleOutput;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ConsoleStatisticsEventOutput implements StatisticsEventOutputInterface
+{
+    protected OutputInterface $output;
+
+    function __construct(OutputInterface $output)
+    {
+        $this->output = $output;
+    }
+
+    public static function fromConsoleOutput(ConsoleOutput $output): self
+    {
+        return static::fromSymfonyOutput($output->getOutput());
+    }
+
+    public static function fromSymfonyOutput(OutputInterface $output): self
+    {
+        return new static($output);
+    }
+
+    public function writeEvent(ContentReleaseIdentifier $contentReleaseIdentifier, string $prefix, string $event, array $additionalPayload): void
+    {
+        $this->output->writeln($prefix . 'STATISTICS EVENT ' . $event . ($additionalPayload ? ' ' . json_encode($additionalPayload) : ''));
+    }
+}

Classes/Core/Infrastructure/ContentReleaseLogger.php

@@ -14,6 +14,11 @@ class ContentReleaseLogger
      */
     protected $output;
 
+    /**
+     * @var StatisticsEventOutputInterface
+     */
+    protected $statisticsEventOutput;
+
     /**
      * @var ContentReleaseIdentifier
      */
@@ -23,10 +28,11 @@ class ContentReleaseLogger
 
     protected ?RendererIdentifier $rendererIdentifier;
 
-    protected function __construct(OutputInterface $output, ContentReleaseIdentifier $contentReleaseIdentifier, ?RendererIdentifier $rendererIdentifier)
+    protected function __construct(OutputInterface $output, ContentReleaseIdentifier $contentReleaseIdentifier, StatisticsEventOutputInterface $statisticsEventOutput, ?RendererIdentifier $rendererIdentifier)
     {
         $this->output = $output;
         $this->contentReleaseIdentifier = $contentReleaseIdentifier;
+        $this->statisticsEventOutput = $statisticsEventOutput;
         $this->rendererIdentifier = $rendererIdentifier;
         $this->logPrefix = '';
 
@@ -36,14 +42,14 @@ protected function __construct(OutputInterface $output, ContentReleaseIdentifier
     }
 
 
-    public static function fromConsoleOutput(ConsoleOutput $output, ContentReleaseIdentifier $contentReleaseIdentifier): self
+    public static function fromConsoleOutput(ConsoleOutput $output, ContentReleaseIdentifier $contentReleaseIdentifier, StatisticsEventOutputInterface $statisticsEventOutput = new RedisStatisticsEventOutput()): self
     {
-        return new static($output->getOutput(), $contentReleaseIdentifier, null);
+        return new static($output->getOutput(), $contentReleaseIdentifier, $statisticsEventOutput, null);
     }
 
-    public static function fromSymfonyOutput(OutputInterface $output, ContentReleaseIdentifier $contentReleaseIdentifier): self
+    public static function fromSymfonyOutput(OutputInterface $output, ContentReleaseIdentifier $contentReleaseIdentifier, StatisticsEventOutputInterface $statisticsEventOutput = new RedisStatisticsEventOutput()): self
     {
-        return new static($output, $contentReleaseIdentifier, null);
+        return new static($output, $contentReleaseIdentifier, $statisticsEventOutput, null);
     }
 
     public function debug(string $message, array $additionalPayload = []): void
@@ -77,8 +83,13 @@ public function logException(\Exception $exception, string $message, array $addi
         $this->output->writeln($this->logPrefix . $message . "\n\n" . $exception->getMessage() . "\n\n" . $exception->getTraceAsString() . "\n\n" . json_encode($additionalPayload));
     }
 
+    public function logStatisticsEvent(string $event, array $additionalPayload = [])
+    {
+        $this->statisticsEventOutput->writeEvent($this->contentReleaseIdentifier, $this->logPrefix, $event, $additionalPayload);
+    }
+
     public function withRenderer(RendererIdentifier $rendererIdentifier): self
     {
-        return new ContentReleaseLogger($this->output, $this->contentReleaseIdentifier, $rendererIdentifier);
+        return new ContentReleaseLogger($this->output, $this->contentReleaseIdentifier, $this->statisticsEventOutput, $rendererIdentifier);
     }
 }

Classes/Core/Infrastructure/RedisStatisticsEventOutput.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\Core\Infrastructure;
+
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\ContentReleaseIdentifier;
+use Flowpack\DecoupledContentStore\Core\RedisKeyService;
+use Neos\Flow\Annotations as Flow;
+
+class RedisStatisticsEventOutput implements StatisticsEventOutputInterface
+{
+
+    #[Flow\Inject]
+    protected RedisClientManager $redisClientManager;
+
+    #[Flow\Inject]
+    protected RedisKeyService $redisKeyService;
+
+    public function writeEvent(ContentReleaseIdentifier $contentReleaseIdentifier, string $prefix, string $event, array $additionalPayload): void
+    {
+        $this->redisClientManager->getPrimaryRedis()->rPush($this->redisKeyService->getRedisKeyForPostfix($contentReleaseIdentifier, 'statisticsEvents'), json_encode([
+            'event' => $event,
+            'prefix' => $prefix,
+            'additionalPayload' => $additionalPayload,
+        ]));
+    }
+}

Classes/Core/Infrastructure/StatisticsEventOutputInterface.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\DecoupledContentStore\Core\Infrastructure;
+
+use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\ContentReleaseIdentifier;
+
+interface StatisticsEventOutputInterface
+{
+    public function writeEvent(ContentReleaseIdentifier $contentReleaseIdentifier, string $prefix, string $event, array $additionalPayload): void;
+}

…ucture/RedisRenderingStatisticsStore.php …re/RedisRenderingTimeStatisticsStore.phpClasses/NodeRendering/Infrastructure/RedisRenderingStatisticsStore.php renamed to Classes/NodeRendering/Infrastructure/RedisRenderingTimeStatisticsStore.php Classes/NodeRendering/Infrastructure/RedisRenderingStatisticsStore.php renamed to Classes/NodeRendering/Infrastructure/RedisRenderingTimeStatisticsStore.php

@@ -14,7 +14,7 @@
 /**
  * @Flow\Scope("singleton")
  */
-class RedisRenderingStatisticsStore
+class RedisRenderingTimeStatisticsStore
 {
 
     /**

Classes/NodeRendering/NodeRenderOrchestrator.php

@@ -9,7 +9,7 @@
 use Flowpack\DecoupledContentStore\NodeRendering\Dto\RenderingStatistics;
 use Flowpack\DecoupledContentStore\NodeRendering\Extensibility\NodeRenderingExtensionManager;
 use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingErrorManager;
-use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingStatisticsStore;
+use Flowpack\DecoupledContentStore\NodeRendering\Infrastructure\RedisRenderingTimeStatisticsStore;
 use Flowpack\DecoupledContentStore\NodeRendering\ProcessEvents\ExitEvent;
 use Flowpack\DecoupledContentStore\NodeRendering\ProcessEvents\RenderingIterationCompletedEvent;
 use Flowpack\DecoupledContentStore\NodeRendering\ProcessEvents\RenderingQueueFilledEvent;
@@ -70,7 +70,7 @@ class NodeRenderOrchestrator
 
     /**
      * @Flow\Inject
-     * @var RedisRenderingStatisticsStore
+     * @var RedisRenderingTimeStatisticsStore
      */
     protected $redisRenderingStatisticsStore;
 

Configuration/Settings.yaml

@@ -142,6 +142,11 @@ Flowpack:
         transfer: true
         transferMode: 'dump'
         isRequired: true
+      statisticsEvents:
+        redisKeyPostfix: 'statisticsEvents'
+        transfer: false
+        transferMode: 'dump'
+        isRequired: false
 
     # can be used on the consuming site to ensure non-breaking deployments for changes in the config
     configEpoch: