Upgrade Promethus lib to 1.x and adapt the code to the new version

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net> # Conflicts: # metrics/core/build.gradle # metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpMetricsSystem.java # metrics/core/src/main/java/org/hyperledger/besu/metrics/opentelemetry/OpenTelemetrySystem.java # metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusMetricsSystem.java # metrics/rocksdb/src/main/java/org/hyperledger/besu/metrics/rocksdb/RocksDBStats.java # plugin-api/build.gradle # plugin-api/src/main/java/org/hyperledger/besu/plugin/services/MetricsSystem.java
hyperledger · Nov 13, 2024 · f5c4ebf · f5c4ebf
1 parent c4a31c8
commit f5c4ebf
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 32 deletions.
diff --git a/ethereum/core/src/main/java/org/hyperledger/besu/ethereum/chain/DefaultBlockchain.java b/ethereum/core/src/main/java/org/hyperledger/besu/ethereum/chain/DefaultBlockchain.java
@@ -183,7 +183,7 @@ private void createGauges(final MetricsSystem metricsSystem) {
 
     metricsSystem.createGauge(
         BLOCKCHAIN,
-        "difficulty_total",
+        "difficulty",
         "Total difficulty of the chainhead",
         () -> this.getChainHead().getTotalDifficulty().toBigInteger().doubleValue());
 

diff --git a/ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/manager/MonitoredExecutors.java b/ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/manager/MonitoredExecutors.java
@@ -155,13 +155,13 @@ private static <T extends ThreadPoolExecutor> T newMonitoredExecutor(
 
     metricsSystem.createLongGauge(
         BesuMetricCategory.EXECUTORS,
-        metricName + "_completed_tasks_total",
+        metricName + "_completed_tasks",
         "Total number of tasks executed",
         executor::getCompletedTaskCount);
 
     metricsSystem.createLongGauge(
         BesuMetricCategory.EXECUTORS,
-        metricName + "_submitted_tasks_total",
+        metricName + "_submitted_tasks",
         "Total number of tasks executed",
         executor::getTaskCount);
 

diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusCollector.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusCollector.java
@@ -35,9 +35,18 @@ public interface PrometheusCollector {
    */
   String getName();
 
-  /** Get the native Prometheus collector */
+  /**
+   * Register this collector to the specified registry
+   *
+   * @param registry the registry
+   */
   void register(final PrometheusRegistry registry);
 
+  /**
+   * Unregister this collector from the specified registry
+   *
+   * @param registry the registry
+   */
   void unregister(final PrometheusRegistry registry);
 
   /**
@@ -57,6 +66,13 @@ static List<String> getLabelValues(final Labels labels) {
     return labels.stream().map(Label::getValue).toList();
   }
 
+  /**
+   * Add new values to an existing list of label values
+   *
+   * @param labelValues existing list of label values
+   * @param values the values to add
+   * @return a new list with new values appended to the original list
+   */
   static List<String> addLabelValues(final List<String> labelValues, final String... values) {
     final var newList = new ArrayList<String>(labelValues.size() + values.length);
     newList.addAll(labelValues);

diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusGuavaCache.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusGuavaCache.java
@@ -28,20 +28,21 @@
 
 class PrometheusGuavaCache extends CategorizedPrometheusCollector {
   private static final String NAME = "__guavaCacheMetricsCollector__";
-  private static final CacheMetricsCollector cacheMetricsCollector = new CacheMetricsCollector();
-  private static final Set<String> cacheNames = new ConcurrentHashSet<>();
-  private static final AtomicBoolean collectorRegistered = new AtomicBoolean(false);
 
   private final Cache<?, ?> cache;
+  private final Context context;
 
   public PrometheusGuavaCache(
-      final MetricCategory category, final String name, final Cache<?, ?> cache) {
-    super(category, NAME);
-    if (cacheNames.contains(name)) {
+      final MetricCategory category,
+      final Context context,
+      final String name,
+      final Cache<?, ?> cache) {
+    super(category, name);
+    if (context.alreadyExists(name)) {
       throw new IllegalStateException("Cache already registered: " + name);
     }
-    cacheNames.add(name);
     this.cache = cache;
+    this.context = context;
   }
 
   @Override
@@ -51,23 +52,49 @@ public String getName() {
 
   @Override
   public void register(final PrometheusRegistry registry) {
-    cacheMetricsCollector.addCache(name, cache);
-    if (collectorRegistered.compareAndSet(false, true)) {
-      registry.register(cacheMetricsCollector);
-    }
+    context.registerCache(registry, name, cache);
   }
 
   @Override
   public void unregister(final PrometheusRegistry registry) {
-    cacheMetricsCollector.removeCache(name);
-    cacheNames.remove(name);
-    if (cacheNames.isEmpty() && collectorRegistered.compareAndSet(true, false)) {
-      registry.unregister(cacheMetricsCollector);
-    }
+    context.unregisterCache(registry, name);
   }
 
   @Override
   public Stream<Observation> streamObservations() {
     return Stream.empty();
   }
+
+  static class Context {
+    private final CacheMetricsCollector cacheMetricsCollector = new CacheMetricsCollector();
+    private final Set<String> cacheNames = new ConcurrentHashSet<>();
+    private final AtomicBoolean collectorRegistered = new AtomicBoolean(false);
+
+    boolean alreadyExists(final String name) {
+      return cacheNames.contains(name);
+    }
+
+    void registerCache(
+        final PrometheusRegistry registry, final String name, final Cache<?, ?> cache) {
+      cacheMetricsCollector.addCache(name, cache);
+      cacheNames.add(name);
+      if (collectorRegistered.compareAndSet(false, true)) {
+        registry.register(cacheMetricsCollector);
+      }
+    }
+
+    void unregisterCache(final PrometheusRegistry registry, final String name) {
+      cacheMetricsCollector.removeCache(name);
+      cacheNames.remove(name);
+      if (cacheNames.isEmpty() && collectorRegistered.compareAndSet(true, false)) {
+        registry.unregister(cacheMetricsCollector);
+      }
+    }
+
+    public void clear() {
+      cacheNames.forEach(cacheMetricsCollector::removeCache);
+      cacheNames.clear();
+      collectorRegistered.set(false);
+    }
+  }
 }
diff --git a/...s/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusMetricsSystem.java b/...s/core/src/main/java/org/hyperledger/besu/metrics/prometheus/PrometheusMetricsSystem.java
@@ -37,7 +37,6 @@
 
 import com.google.common.cache.Cache;
 import com.google.common.collect.ImmutableSet;
-import io.prometheus.metrics.instrumentation.guava.CacheMetricsCollector;
 import io.prometheus.metrics.instrumentation.jvm.JvmBufferPoolMetrics;
 import io.prometheus.metrics.instrumentation.jvm.JvmClassLoadingMetrics;
 import io.prometheus.metrics.instrumentation.jvm.JvmCompilationMetrics;
@@ -69,9 +68,8 @@ public class PrometheusMetricsSystem implements ObservableMetricsSystem {
       cachedCounters = new ConcurrentHashMap<>();
   private final Map<String, LabelledMetric<OperationTimer>> cachedTimers =
       new ConcurrentHashMap<>();
-  private final Map<MetricCategory, CacheMetricsCollector> guavaCacheCollectors =
-      new ConcurrentHashMap<>();
-  private final Set<String> guavaCacheNames = new ConcurrentHashSet<>();
+  private final PrometheusGuavaCache.Context guavaCacheCollectorContext =
+      new PrometheusGuavaCache.Context();
 
   private final Set<MetricCategory> enabledCategories;
   private final boolean timersEnabled;
@@ -213,11 +211,8 @@ public LabelledGauge createLabelledGauge(
   public void createGuavaCacheCollector(
       final MetricCategory category, final String name, final Cache<?, ?> cache) {
     if (isCategoryEnabled(category)) {
-      if (guavaCacheNames.contains(name)) {
-        throw new IllegalStateException("Cache already registered: " + name);
-      }
-      guavaCacheNames.add(name);
-      final var cacheCollector = new PrometheusGuavaCache(category, name, cache);
+      final var cacheCollector =
+          new PrometheusGuavaCache(category, guavaCacheCollectorContext, name, cache);
       registerCollector(category, cacheCollector);
     }
   }
@@ -262,7 +257,6 @@ public void shutdown() {
     collectors.clear();
     cachedCounters.clear();
     cachedTimers.clear();
-    guavaCacheCollectors.clear();
-    guavaCacheNames.clear();
+    guavaCacheCollectorContext.clear();
   }
 }
diff --git a/plugin-api/build.gradle b/plugin-api/build.gradle
@@ -71,7 +71,7 @@ Calculated : ${currentHash}
 tasks.register('checkAPIChanges', FileStateChecker) {
   description = "Checks that the API for the Plugin-API project does not change without deliberate thought"
   files = sourceSets.main.allJava.files
-  knownHash = '/uVL++40w0GJqDavP8+z3Pv8qIdA+G9jvj4os2JvQ/4='
+  knownHash = 'aYWbsgPoKTGDgq9d4QUBvQEaZYbKNJGMiBufzyKnusA='
 }
 check.dependsOn('checkAPIChanges')