feat(18458): add eventSize metrics

Signed-off-by: mxtartaglia <[email protected]>

Author: mxtartaglia-sl

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/event/preconsensus/CommonPcesWriter.java

@@ -5,6 +5,7 @@
 import static com.swirlds.common.units.DataUnit.UNIT_MEGABYTES;
 import static com.swirlds.logging.legacy.LogMarker.EXCEPTION;
 
+import com.hedera.hapi.platform.event.GossipEvent;
 import com.swirlds.common.context.PlatformContext;
 import com.swirlds.common.utility.LongRunningAverage;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -251,6 +252,7 @@ private void pruneOldFiles() {
      */
     public boolean prepareOutputStream(@NonNull final PlatformEvent eventToWrite) throws IOException {
         boolean fileClosed = false;
+        fileManager.updateEventSizeMetric(GossipEvent.PROTOBUF.measureRecord(eventToWrite.getGossipEvent()));
         if (currentMutableFile != null) {
             final boolean fileCanContainEvent = currentMutableFile.canContain(fileType.selectIndicator(eventToWrite));
             final boolean fileIsFull =

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/event/preconsensus/PcesFileManager.java

@@ -300,4 +300,11 @@ private void updateFileSizeMetrics() {
                     .set(((double) totalFileByteCount) / files.getFileCount() * UnitConstants.BYTES_TO_MEBIBYTES);
         }
     }
+
+    /**
+     * Update metrics with the event size.
+     */
+    public void updateEventSizeMetric(final int i) {
+        metrics.updateAvgEventSize(i);
+    }
 }

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/event/preconsensus/PcesMetrics.java

@@ -6,13 +6,16 @@
 import com.swirlds.metrics.api.DoubleGauge;
 import com.swirlds.metrics.api.LongGauge;
 import com.swirlds.metrics.api.Metrics;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import java.util.Objects;
 
 /**
  * Metrics for preconsensus events.
  */
 public class PcesMetrics {
 
     private static final String CATEGORY = "platform";
+    private final Metrics metrics;
 
     private static final LongGauge.Config PRECONSENSUS_EVENT_FILE_COUNT_CONFIG = new LongGauge.Config(
                     CATEGORY, "preconsensusEventFileCount")
@@ -68,12 +71,16 @@ public class PcesMetrics {
             .withDescription("The age of the oldest preconsensus event file, in seconds.");
     private final LongGauge preconsensusEventFileOldestSeconds;
 
+    static final RunningAverageMetric.Config AVG_EVENT_SIZE =
+            new RunningAverageMetric.Config(CATEGORY, "avgEventSize").withDescription("The average size of an event");
+
     /**
      * Construct preconsensus event metrics.
      *
      * @param metrics the metrics manager for the platform
      */
-    public PcesMetrics(final Metrics metrics) {
+    public PcesMetrics(final @NonNull Metrics metrics) {
+        this.metrics = Objects.requireNonNull(metrics);
         preconsensusEventFileCount = metrics.getOrCreate(PRECONSENSUS_EVENT_FILE_COUNT_CONFIG);
         preconsensusEventFileAverageSizeMB = metrics.getOrCreate(PRECONSENSUS_EVENT_FILE_AVERAGE_SIZE_MB_CONFIG);
         preconsensusEventFileTotalSizeGB = metrics.getOrCreate(PRECONSENSUS_EVENT_FILE_TOTAL_SIZE_GB_CONFIG);
@@ -149,4 +156,11 @@ public LongGauge getPreconsensusEventFileYoungestIdentifier() {
     public LongGauge getPreconsensusEventFileOldestSeconds() {
         return preconsensusEventFileOldestSeconds;
     }
+
+    /**
+     * Updates the event size
+     */
+    public void updateAvgEventSize(final int i) {
+        metrics.getOrCreate(AVG_EVENT_SIZE).update(i);
+    }
 }

platform-sdk/swirlds-platform-core/src/test/java/com/swirlds/platform/event/preconsensus/CommonPcesWriterTest.java

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 package com.swirlds.platform.event.preconsensus;
 
+import static org.hiero.base.utility.test.fixtures.RandomUtils.getRandomPrintSeed;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -11,14 +12,12 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import com.hedera.hapi.platform.event.EventDescriptor;
-import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.context.PlatformContext;
 import com.swirlds.config.api.Configuration;
 import com.swirlds.config.extensions.test.fixtures.TestConfigBuilder;
+import com.swirlds.platform.test.fixtures.event.TestingEventBuilder;
 import java.io.IOException;
-import org.hiero.consensus.model.crypto.DigestType;
-import org.hiero.consensus.model.event.EventDescriptorWrapper;
+import java.util.Random;
 import org.hiero.consensus.model.event.PlatformEvent;
 import org.hiero.consensus.model.hashgraph.EventWindow;
 import org.junit.jupiter.api.BeforeEach;
@@ -30,13 +29,24 @@ class CommonPcesWriterTest {
     private PcesFileManager fileManager;
     private CommonPcesWriter commonPcesWriter;
     private PcesMutableFile pcesMutableFile;
+    private PlatformEvent event;
 
     @BeforeEach
     void setUp() throws Exception {
         final Configuration configuration = new TestConfigBuilder().getOrCreateConfig();
         final PlatformContext platformContext = mock(PlatformContext.class);
         when(platformContext.getConfiguration()).thenReturn(configuration);
-
+        final Random random = getRandomPrintSeed();
+        event = new TestingEventBuilder(random)
+                .setAppTransactionCount(3)
+                .setSystemTransactionCount(1)
+                .setSelfParent(
+                        new TestingEventBuilder(random).setBirthRound(150).build())
+                .setOtherParent(
+                        new TestingEventBuilder(random).setBirthRound(150).build())
+                .overrideOtherParentGeneration(150)
+                .setBirthRound(150)
+                .build();
         fileManager = mock(PcesFileManager.class);
         final PcesFile pcesFile = mock(PcesFile.class);
         when(fileManager.getNextFileDescriptor(anyLong(), anyLong())).thenReturn(pcesFile);
@@ -63,7 +73,7 @@ void testBeginStreamingNewEventsAlreadyStreaming() {
     @Test
     void testRegisterDiscontinuity() throws IOException {
         commonPcesWriter.beginStreamingNewEvents();
-        commonPcesWriter.prepareOutputStream(mock(PlatformEvent.class));
+        commonPcesWriter.prepareOutputStream(event);
         commonPcesWriter.registerDiscontinuity(10L);
 
         // Verify file closing and file manager interactions
@@ -92,22 +102,14 @@ void testSetMinimumAncientIdentifierToStore() throws IOException {
 
     @Test
     void testPrepareOutputStreamCreatesNewFile() throws IOException {
-        PlatformEvent mockEvent = mock(PlatformEvent.class);
-        when(mockEvent.getDescriptor())
-                .thenReturn(new EventDescriptorWrapper(EventDescriptor.newBuilder()
-                        .birthRound(150)
-                        .generation(150)
-                        .hash(Bytes.wrap(new byte[DigestType.SHA_384.digestLength()]))
-                        .build()));
-
-        boolean fileClosed = commonPcesWriter.prepareOutputStream(mockEvent);
+        boolean fileClosed = commonPcesWriter.prepareOutputStream(event);
         assertFalse(fileClosed, "A new file should have been created but not closed.");
     }
 
     @Test
     void testCloseCurrentMutableFile() throws IOException {
         commonPcesWriter.beginStreamingNewEvents();
-        commonPcesWriter.prepareOutputStream(mock(PlatformEvent.class));
+        commonPcesWriter.prepareOutputStream(event);
         commonPcesWriter.closeCurrentMutableFile();
         verify(pcesMutableFile, times(1)).close();
     }