Consolidate all metric collectors into the metrics system (#7877)

* Consolidate all metric collectors into the metrics system Signed-off-by: Fabio Di Fabio <[email protected]> * Fixes Signed-off-by: Fabio Di Fabio <[email protected]> * Do not recreate the Prometheus metric system Signed-off-by: Fabio Di Fabio <[email protected]> --------- Signed-off-by: Fabio Di Fabio <[email protected]>
hyperledger · Nov 19, 2024 · 02722bc · 02722bc
1 parent 833a5ce
commit 02722bc
Show file tree

Hide file tree

Showing 23 changed files with 349 additions and 209 deletions.
diff --git a/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceBlock.java b/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceBlock.java
@@ -25,7 +25,6 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTraceGenerator;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.RewardTraceGenerator;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.util.ArrayNodeWrapper;
@@ -41,12 +40,11 @@
 import org.hyperledger.besu.evm.worldstate.WorldUpdater;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
-import org.hyperledger.besu.metrics.prometheus.PrometheusMetricsSystem;
+import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.metrics.Counter;
 import org.hyperledger.besu.plugin.services.metrics.LabelledMetric;
 import org.hyperledger.besu.services.pipeline.Pipeline;
 
-import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 
@@ -58,10 +56,21 @@ public class TraceBlock extends AbstractBlockParameterMethod {
   private static final Logger LOG = LoggerFactory.getLogger(TraceBlock.class);
   private static final ObjectMapper MAPPER = new ObjectMapper();
   protected final ProtocolSchedule protocolSchedule;
+  private final LabelledMetric<Counter> outputCounter;
 
-  public TraceBlock(final ProtocolSchedule protocolSchedule, final BlockchainQueries queries) {
+  public TraceBlock(
+      final ProtocolSchedule protocolSchedule,
+      final BlockchainQueries queries,
+      final MetricsSystem metricsSystem) {
     super(queries);
     this.protocolSchedule = protocolSchedule;
+    this.outputCounter =
+        metricsSystem.createLabelledCounter(
+            BesuMetricCategory.BLOCKCHAIN,
+            "transactions_traceblock_pipeline_processed_total",
+            "Number of transactions processed for each block",
+            "step",
+            "action");
   }
 
   @Override
@@ -115,14 +124,6 @@ protected ArrayNodeWrapper traceBlock(
               final ChainUpdater chainUpdater = new ChainUpdater(traceableState);
 
               TransactionSource transactionSource = new TransactionSource(block);
-              final LabelledMetric<Counter> outputCounter =
-                  new PrometheusMetricsSystem(BesuMetricCategory.DEFAULT_METRIC_CATEGORIES, false)
-                      .createLabelledCounter(
-                          BesuMetricCategory.BLOCKCHAIN,
-                          "transactions_traceblock_pipeline_processed_total",
-                          "Number of transactions processed for each block",
-                          "step",
-                          "action");
               DebugOperationTracer debugOperationTracer =
                   new DebugOperationTracer(new TraceOptions(false, false, true), false);
               ExecuteTransactionStep executeTransactionStep =
@@ -173,18 +174,6 @@ protected ArrayNodeWrapper traceBlock(
         .orElse(emptyResult());
   }
 
-  protected void generateTracesFromTransactionTraceAndBlock(
-      final Optional<FilterParameter> filterParameter,
-      final List<TransactionTrace> transactionTraces,
-      final Block block,
-      final ArrayNodeWrapper resultArrayNode) {
-    transactionTraces.forEach(
-        transactionTrace ->
-            FlatTraceGenerator.generateFromTransactionTraceAndBlock(
-                    protocolSchedule, transactionTrace, block)
-                .forEachOrdered(resultArrayNode::addPOJO));
-  }
-
   protected void generateRewardsFromBlock(
       final Optional<FilterParameter> maybeFilterParameter,
       final Block block,

diff --git a/...src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceFilter.java b/...src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceFilter.java
@@ -23,7 +23,6 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.BlockParameter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.FilterParameter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter.JsonRpcParameterException;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.BlockTracer;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
@@ -45,7 +44,7 @@
 import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
-import org.hyperledger.besu.metrics.prometheus.PrometheusMetricsSystem;
+import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.metrics.Counter;
 import org.hyperledger.besu.plugin.services.metrics.LabelledMetric;
 import org.hyperledger.besu.services.pipeline.Pipeline;
@@ -58,7 +57,6 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.function.Function;
-import java.util.function.Supplier;
 import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 
@@ -68,17 +66,24 @@
 import org.slf4j.LoggerFactory;
 
 public class TraceFilter extends TraceBlock {
-
   private static final Logger LOG = LoggerFactory.getLogger(TraceFilter.class);
   private final Long maxRange;
+  private final LabelledMetric<Counter> outputCounter;
 
   public TraceFilter(
-      final Supplier<BlockTracer> blockTracerSupplier,
       final ProtocolSchedule protocolSchedule,
       final BlockchainQueries blockchainQueries,
-      final Long maxRange) {
-    super(protocolSchedule, blockchainQueries);
+      final Long maxRange,
+      final MetricsSystem metricsSystem) {
+    super(protocolSchedule, blockchainQueries, metricsSystem);
     this.maxRange = maxRange;
+    this.outputCounter =
+        metricsSystem.createLabelledCounter(
+            BesuMetricCategory.BLOCKCHAIN,
+            "transactions_tracefilter_pipeline_processed_total",
+            "Number of transactions processed for trace_filter",
+            "step",
+            "action");
   }
 
   @Override
@@ -157,15 +162,6 @@ private JsonRpcResponse traceFilterWithPipeline(
                   final MainnetTransactionProcessor transactionProcessor =
                       protocolSpec.getTransactionProcessor();
                   final ChainUpdater chainUpdater = new ChainUpdater(traceableState);
-                  final LabelledMetric<Counter> outputCounter =
-                      new PrometheusMetricsSystem(
-                              BesuMetricCategory.DEFAULT_METRIC_CATEGORIES, false)
-                          .createLabelledCounter(
-                              BesuMetricCategory.BLOCKCHAIN,
-                              "transactions_tracefilter_pipeline_processed_total",
-                              "Number of transactions processed for trace_filter",
-                              "step",
-                              "action");
 
                   DebugOperationTracer debugOperationTracer =
                       new DebugOperationTracer(new TraceOptions(false, false, true), false);

diff --git a/.../hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceReplayBlockTransactions.java b/.../hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceReplayBlockTransactions.java
@@ -39,7 +39,7 @@
 import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
-import org.hyperledger.besu.metrics.prometheus.PrometheusMetricsSystem;
+import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.metrics.Counter;
 import org.hyperledger.besu.plugin.services.metrics.LabelledMetric;
 import org.hyperledger.besu.services.pipeline.Pipeline;
@@ -57,13 +57,23 @@
 
 public class TraceReplayBlockTransactions extends AbstractBlockParameterMethod {
   private static final Logger LOG = LoggerFactory.getLogger(TraceReplayBlockTransactions.class);
-  private final ProtocolSchedule protocolSchedule;
   private static final ObjectMapper MAPPER = new ObjectMapper();
+  private final ProtocolSchedule protocolSchedule;
+  private final LabelledMetric<Counter> outputCounter;
 
   public TraceReplayBlockTransactions(
-      final ProtocolSchedule protocolSchedule, final BlockchainQueries queries) {
+      final ProtocolSchedule protocolSchedule,
+      final BlockchainQueries queries,
+      final MetricsSystem metricsSystem) {
     super(queries);
     this.protocolSchedule = protocolSchedule;
+    this.outputCounter =
+        metricsSystem.createLabelledCounter(
+            BesuMetricCategory.BLOCKCHAIN,
+            "transactions_tracereplayblock_pipeline_processed_total",
+            "Number of transactions processed for each block",
+            "step",
+            "action");
   }
 
   @Override
@@ -131,14 +141,7 @@ private ArrayNode traceBlock(final Block block, final TraceTypeParameter traceTy
               final ChainUpdater chainUpdater = new ChainUpdater(traceableState);
 
               final TransactionSource transactionSource = new TransactionSource(block);
-              final LabelledMetric<Counter> outputCounter =
-                  new PrometheusMetricsSystem(BesuMetricCategory.DEFAULT_METRIC_CATEGORIES, false)
-                      .createLabelledCounter(
-                          BesuMetricCategory.BLOCKCHAIN,
-                          "transactions_tracereplayblock_pipeline_processed_total",
-                          "Number of transactions processed for each block",
-                          "step",
-                          "action");
+
               final DebugOperationTracer debugOperationTracer =
                   new DebugOperationTracer(new TraceOptions(false, false, true), false);
               final ExecuteTransactionStep executeTransactionStep =

diff --git a/...rc/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/JsonRpcMethodsFactory.java b/...rc/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/JsonRpcMethodsFactory.java
@@ -151,7 +151,11 @@ public Map<String, JsonRpcMethod> methods(
                   blockchainQueries, protocolSchedule, transactionPool, privacyParameters),
               new Web3JsonRpcMethods(clientNodeName),
               new TraceJsonRpcMethods(
-                  blockchainQueries, protocolSchedule, protocolContext, apiConfiguration),
+                  blockchainQueries,
+                  protocolSchedule,
+                  protocolContext,
+                  apiConfiguration,
+                  metricsSystem),
               new TxPoolJsonRpcMethods(transactionPool),
               new PluginsJsonRpcMethods(namedPlugins));
 

diff --git a/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/TraceJsonRpcMethods.java b/.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/TraceJsonRpcMethods.java
@@ -31,26 +31,29 @@
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
+import org.hyperledger.besu.plugin.services.MetricsSystem;
 
 import java.util.Map;
 
 public class TraceJsonRpcMethods extends ApiGroupJsonRpcMethods {
 
   private final BlockchainQueries blockchainQueries;
   private final ProtocolSchedule protocolSchedule;
-
   private final ApiConfiguration apiConfiguration;
   private final ProtocolContext protocolContext;
+  private final MetricsSystem metricsSystem;
 
   TraceJsonRpcMethods(
       final BlockchainQueries blockchainQueries,
       final ProtocolSchedule protocolSchedule,
       final ProtocolContext protocolContext,
-      final ApiConfiguration apiConfiguration) {
+      final ApiConfiguration apiConfiguration,
+      final MetricsSystem metricsSystem) {
     this.blockchainQueries = blockchainQueries;
     this.protocolSchedule = protocolSchedule;
     this.protocolContext = protocolContext;
     this.apiConfiguration = apiConfiguration;
+    this.metricsSystem = metricsSystem;
   }
 
   @Override
@@ -63,16 +66,16 @@ protected Map<String, JsonRpcMethod> create() {
     final BlockReplay blockReplay =
         new BlockReplay(protocolSchedule, protocolContext, blockchainQueries.getBlockchain());
     return mapOf(
-        new TraceReplayBlockTransactions(protocolSchedule, blockchainQueries),
+        new TraceReplayBlockTransactions(protocolSchedule, blockchainQueries, metricsSystem),
         new TraceFilter(
-            () -> new BlockTracer(blockReplay),
             protocolSchedule,
             blockchainQueries,
-            apiConfiguration.getMaxTraceFilterRange()),
+            apiConfiguration.getMaxTraceFilterRange(),
+            metricsSystem),
         new TraceGet(() -> new BlockTracer(blockReplay), blockchainQueries, protocolSchedule),
         new TraceTransaction(
             () -> new BlockTracer(blockReplay), protocolSchedule, blockchainQueries),
-        new TraceBlock(protocolSchedule, blockchainQueries),
+        new TraceBlock(protocolSchedule, blockchainQueries, metricsSystem),
         new TraceCall(
             blockchainQueries,
             protocolSchedule,

diff --git a/...test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceFilterTest.java b/...test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceFilterTest.java
@@ -26,6 +26,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
+import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
 
 import java.util.function.Supplier;
 
@@ -69,7 +70,8 @@ public void shouldFailIfParamsExceedMaxRange(
             new JsonRpcRequest("2.0", "trace_filter", new Object[] {filterParameter}));
 
     method =
-        new TraceFilter(blockTracerSupplier, protocolSchedule, blockchainQueries, maxFilterRange);
+        new TraceFilter(
+            protocolSchedule, blockchainQueries, maxFilterRange, new NoOpMetricsSystem());
 
     final JsonRpcResponse response = method.response(request);
     assertThat(response).isInstanceOf(JsonRpcErrorResponse.class);

diff --git a/ethereum/core/build.gradle b/ethereum/core/build.gradle
@@ -65,8 +65,6 @@ dependencies {
   implementation 'org.immutables:value-annotations'
   implementation 'tech.pegasys:jc-kzg-4844'
 
-  implementation 'io.prometheus:simpleclient_guava'
-
   implementation 'org.xerial.snappy:snappy-java'
 
   annotationProcessor 'org.immutables:value'

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
@@ -19,6 +19,7 @@
 import static java.util.Collections.emptyList;
 import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toList;
+import static org.hyperledger.besu.metrics.BesuMetricCategory.BLOCKCHAIN;
 
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.ethereum.chain.BlockchainStorage.Updater;
@@ -32,7 +33,6 @@
 import org.hyperledger.besu.ethereum.core.TransactionReceipt;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
-import org.hyperledger.besu.metrics.prometheus.PrometheusMetricsSystem;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.metrics.Counter;
 import org.hyperledger.besu.util.InvalidConfigurationException;
@@ -56,7 +56,6 @@
 import com.google.common.cache.CacheBuilder;
 import com.google.common.collect.Lists;
 import com.google.common.collect.Streams;
-import io.prometheus.client.guava.cache.CacheMetricsCollector;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -134,13 +133,12 @@ private DefaultBlockchain(
       totalDifficultyCache =
           Optional.of(
               CacheBuilder.newBuilder().recordStats().maximumSize(numberOfBlocksToCache).build());
-      CacheMetricsCollector cacheMetrics = new CacheMetricsCollector();
-      cacheMetrics.addCache("blockHeaders", blockHeadersCache.get());
-      cacheMetrics.addCache("blockBodies", blockBodiesCache.get());
-      cacheMetrics.addCache("transactionReceipts", transactionReceiptsCache.get());
-      cacheMetrics.addCache("totalDifficulty", totalDifficultyCache.get());
-      if (metricsSystem instanceof PrometheusMetricsSystem prometheusMetricsSystem)
-        prometheusMetricsSystem.addCollector(BesuMetricCategory.BLOCKCHAIN, () -> cacheMetrics);
+      metricsSystem.createGuavaCacheCollector(BLOCKCHAIN, "blockHeaders", blockHeadersCache.get());
+      metricsSystem.createGuavaCacheCollector(BLOCKCHAIN, "blockBodies", blockBodiesCache.get());
+      metricsSystem.createGuavaCacheCollector(
+          BLOCKCHAIN, "transactionReceipts", transactionReceiptsCache.get());
+      metricsSystem.createGuavaCacheCollector(
+          BLOCKCHAIN, "totalDifficulty", totalDifficultyCache.get());
     } else {
       blockHeadersCache = Optional.empty();
       blockBodiesCache = Optional.empty();
@@ -155,11 +153,11 @@ private DefaultBlockchain(
   private void createCounters(final MetricsSystem metricsSystem) {
     gasUsedCounter =
         metricsSystem.createCounter(
-            BesuMetricCategory.BLOCKCHAIN, "chain_head_gas_used_counter", "Counter for Gas used");
+            BLOCKCHAIN, "chain_head_gas_used_counter", "Counter for Gas used");
 
     numberOfTransactionsCounter =
         metricsSystem.createCounter(
-            BesuMetricCategory.BLOCKCHAIN,
+            BLOCKCHAIN,
             "chain_head_transaction_count_counter",
             "Counter for the number of transactions");
   }
@@ -184,37 +182,37 @@ private void createGauges(final MetricsSystem metricsSystem) {
         this::getSafeBlockNumber);
 
     metricsSystem.createGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "difficulty_total",
         "Total difficulty of the chainhead",
         () -> this.getChainHead().getTotalDifficulty().toBigInteger().doubleValue());
 
     metricsSystem.createLongGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "chain_head_timestamp",
         "Timestamp from the current chain head",
         () -> getChainHeadHeader().getTimestamp());
 
     metricsSystem.createLongGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "chain_head_gas_used",
         "Gas used by the current chain head block",
         () -> getChainHeadHeader().getGasUsed());
 
     metricsSystem.createLongGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "chain_head_gas_limit",
         "Block gas limit of the current chain head block",
         () -> getChainHeadHeader().getGasLimit());
 
     metricsSystem.createIntegerGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "chain_head_transaction_count",
         "Number of transactions in the current chain head block",
         () -> chainHeadTransactionCount);
 
     metricsSystem.createIntegerGauge(
-        BesuMetricCategory.BLOCKCHAIN,
+        BLOCKCHAIN,
         "chain_head_ommer_count",
         "Number of ommers in the current chain head block",
         () -> chainHeadOmmerCount);