add head metrics gauge

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

Author: garyschulte

core/build.gradle

@@ -20,6 +20,7 @@ dependencies {
     implementation project(':crypto')
     implementation project(':services:storage:api')
     implementation project(':services:storage:rocksdb')
+    implementation project(':services:metrics')
 
     implementation 'org.hyperledger.besu.internal:trie'
     implementation 'org.hyperledger.besu.internal:core'
@@ -40,4 +41,4 @@ dependencies {
     testImplementation 'junit:junit'
     testImplementation 'org.assertj:assertj-core'
 
-}
+}

core/src/main/java/net/consensys/shomei/storage/ZkWorldStateArchive.java

@@ -14,6 +14,7 @@
 package net.consensys.shomei.storage;
 
 import net.consensys.shomei.exception.MissingTrieLogException;
+import net.consensys.shomei.metrics.MetricsService;
 import net.consensys.shomei.observer.TrieLogObserver.TrieLogIdentifier;
 import net.consensys.shomei.storage.worldstate.WorldStateStorage;
 import net.consensys.shomei.trielog.TrieLogLayer;
@@ -22,6 +23,7 @@
 
 import java.io.Closeable;
 import java.io.IOException;
+import java.util.Collections;
 import java.util.Comparator;
 import java.util.Map;
 import java.util.Optional;
@@ -56,14 +58,16 @@ public ZkWorldStateArchive(
         storageProvider.getTrieLogManager(),
         storageProvider.getTraceManager(),
         storageProvider.getWorldStateStorage(),
-        enableFinalizedBlockLimit);
+        enableFinalizedBlockLimit,
+        MetricsService.MetricsServiceProvider.getMetricsService());
   }
 
   public ZkWorldStateArchive(
       final TrieLogManager trieLogManager,
       final TraceManager traceManager,
       final WorldStateStorage headWorldStateStorage,
-      final boolean enableFinalizedBlockLimit) {
+      final boolean enableFinalizedBlockLimit,
+      final MetricsService metricsService) {
     this.trieLogManager = trieLogManager;
     this.traceManager = traceManager;
     this.headWorldStateStorage = headWorldStateStorage;
@@ -75,6 +79,7 @@ public ZkWorldStateArchive(
           headWorldStateStorage);
       LOG.debug("Worldstate archive created snapshot for " + headWorldState.getBlockNumber());
     }
+    setupHeadMetrics(metricsService);
   }
 
   public Optional<ZkEvmWorldState> getCachedWorldState(Hash blockHash) {
@@ -103,6 +108,14 @@ Map<TrieLogIdentifier, WorldStateStorage> getCachedWorldStates() {
     return cachedWorldStates;
   }
 
+  private void setupHeadMetrics(MetricsService metricsService) {
+    metricsService.addGauge(
+        "shomei_blockchain_head",
+        "current chain head block number which corresponds to shomei state",
+        Collections.emptyList(),
+        this::getCurrentBlockNumber);
+  }
+
   private ZkEvmWorldState fromWorldStateStorage(WorldStateStorage storage) {
     return new ZkEvmWorldState(storage, traceManager);
   }

core/src/test/java/net/consensys/shomei/storage/ZkWorldStateArchiveTests.java

@@ -16,6 +16,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import net.consensys.shomei.exception.MissingTrieLogException;
+import net.consensys.shomei.metrics.MetricsService;
+import net.consensys.shomei.metrics.NoOpMetricsService;
 import net.consensys.shomei.observer.TrieLogObserver.TrieLogIdentifier;
 import net.consensys.shomei.trielog.PluginTrieLogLayer;
 import net.consensys.shomei.trielog.TrieLogLayerConverter;
@@ -33,6 +35,7 @@ public class ZkWorldStateArchiveTests {
   ZkWorldStateArchive archive = new ZkWorldStateArchive(new InMemoryStorageProvider());
   TrieLogLayerConverter converter = new TrieLogLayerConverter(archive.getHeadWorldStateStorage());
   ZkTrieLogFactory encoder = new ZkTrieLogFactory();
+  MetricsService noopMetrics = new NoOpMetricsService();
 
   @Test
   public void shouldDropWorldStatesFromHead() {
@@ -108,7 +111,7 @@ public void verifyStorageSnapshotAtStart() throws MissingTrieLogException {
             archive.getTrieLogManager(),
             archive.getTraceManager(),
             archive.getHeadWorldStateStorage(),
-            false);
+            false, noopMetrics);
 
     assertThat(zkWorldStateArchive.getCachedWorldState(0L).isPresent()).isFalse();
 
@@ -117,7 +120,7 @@ public void verifyStorageSnapshotAtStart() throws MissingTrieLogException {
             archive.getTrieLogManager(),
             archive.getTraceManager(),
             archive.getHeadWorldStateStorage(),
-            true);
+            true, noopMetrics);
 
     assertThat(zkWorldStateArchive.getCachedWorldState(0L).isPresent()).isTrue();
   }

services/metrics/build.gradle

@@ -20,8 +20,8 @@ dependencies {
     implementation 'io.vertx:vertx-core'
     implementation 'io.vertx:vertx-web'
     implementation 'io.vertx:vertx-micrometer-metrics'
-    implementation 'io.micrometer:micrometer-core'
     implementation 'io.micrometer:micrometer-registry-prometheus'
+    api 'io.micrometer:micrometer-core'
 
 
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
@@ -31,4 +31,4 @@ dependencies {
 
 test {
     useJUnitPlatform()
-}
+}

services/metrics/src/main/java/net/consensys/shomei/metrics/MetricsService.java

@@ -14,14 +14,20 @@
 package net.consensys.shomei.metrics;
 
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.function.Supplier;
 
 import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Tag;
 import io.vertx.core.Verticle;
 
-public interface MetricsService extends Verticle {
+public interface MetricsService {
 
   MeterRegistry getRegistry();
 
+  void addGauge(String name, String description, Iterable<Tag> tags, Supplier<Number> supplier);
+
+  interface VertxMetricsService extends MetricsService, Verticle {}
+
   class MetricsServiceProvider {
     private static final AtomicReference<MetricsService> METRICS_SERVICE = new AtomicReference<>();
 

services/metrics/src/main/java/net/consensys/shomei/metrics/NoOpMetricsService.java

@@ -13,16 +13,15 @@
 
 package net.consensys.shomei.metrics;
 
+import java.util.function.Supplier;
+
 import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Tag;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
-import io.vertx.core.Context;
-import io.vertx.core.Promise;
-import io.vertx.core.Vertx;
 
 public class NoOpMetricsService implements MetricsService {
 
   private final MeterRegistry meterRegistry;
-  private Vertx vertx;
 
   public NoOpMetricsService() {
     this.meterRegistry = new SimpleMeterRegistry();
@@ -34,22 +33,11 @@ public MeterRegistry getRegistry() {
   }
 
   @Override
-  public Vertx getVertx() {
-    return vertx;
-  }
-
-  @Override
-  public void init(final Vertx vertx, final Context context) {
-    this.vertx = vertx;
-  }
-
-  @Override
-  public void start(final Promise<Void> startPromise) throws Exception {
-    // no-op
-  }
-
-  @Override
-  public void stop(final Promise<Void> stopPromise) throws Exception {
+  public void addGauge(
+      final String name,
+      final String description,
+      final Iterable<Tag> tags,
+      final Supplier<Number> supplier) {
     // no-op
   }
 }

services/metrics/src/main/java/net/consensys/shomei/metrics/PrometheusMetricsService.java

@@ -13,14 +13,19 @@
 
 package net.consensys.shomei.metrics;
 
+import java.util.function.Supplier;
+
+import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Tag;
 import io.micrometer.prometheus.PrometheusConfig;
 import io.micrometer.prometheus.PrometheusMeterRegistry;
 import io.vertx.core.AbstractVerticle;
 import io.vertx.core.Promise;
 import io.vertx.ext.web.Router;
 
-public class PrometheusMetricsService extends AbstractVerticle implements MetricsService {
+public class PrometheusMetricsService extends AbstractVerticle
+    implements MetricsService.VertxMetricsService {
   private final PrometheusMeterRegistry prometheusMeterRegistry;
   private final String host;
   private final int port;
@@ -36,6 +41,20 @@ public MeterRegistry getRegistry() {
     return prometheusMeterRegistry;
   }
 
+  @Override
+  public void addGauge(
+      final String name,
+      final String description,
+      final Iterable<Tag> tags,
+      final Supplier<Number> supplier) {
+
+    // Register a gauge to track this value
+    Gauge.builder(name, supplier)
+        .description(description)
+        .tags(tags)
+        .register(prometheusMeterRegistry);
+  }
+
   @Override
   public void start(Promise<Void> startPromise) {
 

shomei/src/main/java/net/consensys/shomei/Runner.java

@@ -50,7 +50,7 @@ public class Runner {
   private final FullSyncDownloader fullSyncDownloader;
   private final JsonRpcService jsonRpcService;
 
-  private final MetricsService metricsService;
+  private final MetricsService.VertxMetricsService metricsService;
 
   private final ZkWorldStateArchive worldStateArchive;
 
@@ -103,9 +103,9 @@ private void setupHashFunction(HashFunctionOption hashFunctionOption) {
     HashProvider.setTrieHashFunction(hashFunctionOption.getHashFunction());
   }
 
-  private MetricsService setupMetrics(MetricsOption metricsOption) {
+  private MetricsService.VertxMetricsService setupMetrics(MetricsOption metricsOption) {
     // use prometheus as metrics service
-    MetricsService metricsService =
+    MetricsService.VertxMetricsService metricsService =
         new PrometheusMetricsService(
             metricsOption.getMetricsHttpHost(), metricsOption.getMetricsHttpPort());
     MeterRegistry meterRegistry = metricsService.getRegistry();