feat: add metric for block compression ratio and blob utilization ratio

Consensys · Dec 5, 2024 · 7ee6316 · 7ee6316
1 parent 4028a4a
commit 7ee6316
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/...tor/core/src/main/kotlin/net/consensys/zkevm/ethereum/coordination/blob/BlobCompressor.kt b/...tor/core/src/main/kotlin/net/consensys/zkevm/ethereum/coordination/blob/BlobCompressor.kt
@@ -38,7 +38,8 @@ interface BlobCompressor {
 }
 
 class GoBackedBlobCompressor private constructor(
-  internal val goNativeBlobCompressor: GoNativeBlobCompressor,
+  private val goNativeBlobCompressor: GoNativeBlobCompressor,
+  private val dataLimit: UInt,
   private val metricsFacade: MetricsFacade
 ) : BlobCompressor {
 
@@ -62,7 +63,7 @@ class GoBackedBlobCompressor private constructor(
             if (!initialized) {
               throw InstantiationException(goNativeBlobCompressor.Error())
             }
-            instance = GoBackedBlobCompressor(goNativeBlobCompressor, metricsFacade)
+            instance = GoBackedBlobCompressor(goNativeBlobCompressor, dataLimit, metricsFacade)
           } else {
             throw IllegalStateException("Compressor singleton instance already created")
           }
@@ -84,6 +85,16 @@ class GoBackedBlobCompressor private constructor(
     name = "compressor.appendblock",
     description = "Time taken to compress block into current blob"
   )
+  private val compressionRatioHistogram = metricsFacade.createHistogram(
+    category = LineaMetricsCategory.BLOB,
+    name = "block.compression.ratio",
+    description = "Block compression ratio measured in [0.0,1.0]"
+  )
+  private val utilizationRatioHistogram = metricsFacade.createHistogram(
+    category = LineaMetricsCategory.BLOB,
+    name = "data.utilization.ratio",
+    description = "Data utilization ratio of a blob measured in [0.0,1.0]"
+  )
 
   private val log = LogManager.getLogger(GoBackedBlobCompressor::class.java)
 
@@ -99,7 +110,9 @@ class GoBackedBlobCompressor private constructor(
       goNativeBlobCompressor.Write(blockRLPEncoded, blockRLPEncoded.size)
     }
     val compressedSizeAfter = goNativeBlobCompressor.Len()
-    val compressionRatio = 1.0 - ((compressedSizeAfter - compressionSizeBefore).toDouble() / blockRLPEncoded.size)
+    val compressionRatio = (1.0 - (compressedSizeAfter - compressionSizeBefore).toDouble() / blockRLPEncoded.size)
+      .also { compressionRatioHistogram.record(it) }
+
     log.trace(
       "block compressed: blockRlpSize={} compressionDataBefore={} compressionDataAfter={} compressionRatio={}",
       blockRLPEncoded.size,
@@ -122,6 +135,7 @@ class GoBackedBlobCompressor private constructor(
   override fun getCompressedData(): ByteArray {
     val compressedData = ByteArray(goNativeBlobCompressor.Len())
     goNativeBlobCompressor.Bytes(compressedData)
+    utilizationRatioHistogram.record(goNativeBlobCompressor.Len().toDouble() / dataLimit.toInt())
     return compressedData
   }
 

diff --git a/...c/integrationTest/kotlin/net/consensys/zkevm/persistence/dao/blob/BlobsPostgresDaoTest.kt b/...c/integrationTest/kotlin/net/consensys/zkevm/persistence/dao/blob/BlobsPostgresDaoTest.kt
@@ -23,7 +23,6 @@ import org.junit.jupiter.api.assertThrows
 import org.junit.jupiter.api.extension.ExtendWith
 import tech.pegasys.teku.infrastructure.async.SafeFuture
 import java.util.concurrent.ExecutionException
-import kotlin.random.Random
 import kotlin.time.Duration.Companion.seconds
 import kotlin.time.toJavaDuration
 
@@ -45,7 +44,6 @@ class BlobsPostgresDaoTest : CleanDbTestSuiteParallel() {
   private val expectedEndBlock = 100UL
   private val expectedStartBlockTime = fakeClock.now().trimToSecondPrecision()
   private val expectedEndBlockTime = fakeClock.now().plus(1200.seconds).trimToMillisecondPrecision()
-  private val expectedShnarf = Random.nextBytes(32)
 
   @BeforeEach
   fun beforeEach() {

diff --git a/jvm-libs/linea/core/metrics/src/main/kotlin/net/consensys/linea/metrics/MetricsFacade.kt b/jvm-libs/linea/core/metrics/src/main/kotlin/net/consensys/linea/metrics/MetricsFacade.kt
@@ -56,7 +56,7 @@ interface MetricsFacade {
     name: String,
     description: String,
     tags: List<Tag> = emptyList(),
-    baseUnit: String
+    baseUnit: String? = null
   ): Histogram
 
   fun <T> createSimpleTimer(

diff --git a/...rometer/src/main/kotlin/net/consensys/linea/metrics/micrometer/MicrometerMetricsFacade.kt b/...rometer/src/main/kotlin/net/consensys/linea/metrics/micrometer/MicrometerMetricsFacade.kt
@@ -91,11 +91,11 @@ class MicrometerMetricsFacade(
     name: String,
     description: String,
     tags: List<Tag>,
-    baseUnit: String
+    baseUnit: String?
   ): Histogram {
     if (category != null) requireValidMicrometerName(category.toString())
     requireValidMicrometerName(name)
-    requireValidBaseUnit(baseUnit)
+    if (baseUnit != null) requireValidBaseUnit(baseUnit)
     val distributionSummaryBuilder = DistributionSummary.builder(metricHandle(category, name))
     if (tags.isNotEmpty()) {
       val flatTags = tags.flatMap {