feat: SCSC metrics for #TXs that fail pureCheck (P1 level)

- counts for CONTRACT_CREATE / CONTRACT_CALL / ETHEREUM_TRANSACTION that fail pureCheck for any reason - and for those that fail pureCheck because they don't even have the intrinsic gas amount - and for Type 3 format (BLOB) Ethereum transactions (that we don't support) By: - Change plumbing for metrics into smart contract service - Metrics are controlled by feature flags in `ContractsConfig` - Added `AbstractContractTransactionHandler` abstract class to hold a growing amount of commonality in smart contract transaction handler classes. Signed-off-by: David S Bakin <[email protected]>
hashgraph · Dec 3, 2024 · 89f4a1b · 89f4a1b
1 parent f881978
commit 89f4a1b
Show file tree

Hide file tree

Showing 23 changed files with 659 additions and 79 deletions.
diff --git a/hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/AppContext.java b/hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/AppContext.java
@@ -22,6 +22,7 @@
 import com.hedera.node.app.spi.throttle.Throttle;
 import com.swirlds.common.crypto.Signature;
 import com.swirlds.config.api.Configuration;
+import com.swirlds.metrics.api.Metrics;
 import com.swirlds.state.lifecycle.Service;
 import com.swirlds.state.lifecycle.info.NodeInfo;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -105,6 +106,12 @@ public Signature sign(final byte[] ledgerId) {
      */
     Supplier<NodeInfo> selfNodeInfoSupplier();
 
+    /**
+     * The supplier of (platform) metrics
+     * @return the supplier
+     */
+    Supplier<Metrics> metricsSupplier();
+
     /**
      * The application's strategy for creating {@link Throttle} instances.
      * @return the throttle factory

diff --git a/hedera-node/hedera-app-spi/src/main/java/module-info.java b/hedera-node/hedera-app-spi/src/main/java/module-info.java
@@ -3,6 +3,7 @@
     requires transitive com.hedera.node.hapi;
     requires transitive com.swirlds.common;
     requires transitive com.swirlds.config.api;
+    requires transitive com.swirlds.metrics.api;
     requires transitive com.swirlds.state.api;
     requires transitive com.hedera.pbj.runtime;
     requires static com.github.spotbugs.annotations;

diff --git a/...-node/hedera-app/src/jmh/java/com/hedera/node/app/blocks/BlockStreamManagerBenchmark.java b/...-node/hedera-app/src/jmh/java/com/hedera/node/app/blocks/BlockStreamManagerBenchmark.java
@@ -55,6 +55,7 @@
 import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.crypto.Hash;
 import com.swirlds.common.metrics.noop.NoOpMetrics;
+import com.swirlds.metrics.api.Metrics;
 import com.swirlds.platform.state.service.PlatformStateService;
 import com.swirlds.platform.state.service.schemas.V0540PlatformStateSchema;
 import com.swirlds.platform.system.Round;
@@ -104,6 +105,7 @@ public class BlockStreamManagerBenchmark {
     private static final String SAMPLE_BLOCK = "sample.blk.gz";
     private static final Instant FAKE_CONSENSUS_NOW = Instant.ofEpochSecond(1_234_567L, 890);
     private static final Timestamp FAKE_CONSENSUS_TIME = new Timestamp(1_234_567L, 890);
+    private static final Metrics NO_OP_METRICS = new NoOpMetrics();
     private static final SemanticVersion VERSION = new SemanticVersion(0, 56, 0, "", "");
 
     public static void main(String... args) throws Exception {
@@ -124,6 +126,7 @@ public static void main(String... args) throws Exception {
             UNAVAILABLE_GOSSIP,
             configProvider::getConfiguration,
             () -> DEFAULT_NODE_INFO,
+            () -> NO_OP_METRICS,
             (split, snapshots) -> {
                 throw new UnsupportedOperationException();
             });

diff --git a/...ra-node/hedera-app/src/jmh/java/com/hedera/node/app/blocks/StandaloneRoundManagement.java b/...ra-node/hedera-app/src/jmh/java/com/hedera/node/app/blocks/StandaloneRoundManagement.java
@@ -56,6 +56,7 @@
 import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.crypto.Hash;
 import com.swirlds.common.metrics.noop.NoOpMetrics;
+import com.swirlds.metrics.api.Metrics;
 import com.swirlds.platform.state.service.PlatformStateService;
 import com.swirlds.platform.state.service.schemas.V0540PlatformStateSchema;
 import com.swirlds.platform.system.Round;
@@ -84,6 +85,7 @@ public class StandaloneRoundManagement {
     private static final String SAMPLE_BLOCK = "sample.blk.gz";
     private static final Instant FAKE_CONSENSUS_NOW = Instant.ofEpochSecond(1_234_567L, 890);
     private static final Timestamp FAKE_CONSENSUS_TIME = new Timestamp(1_234_567L, 890);
+    private static final Metrics NO_OP_METRICS = new NoOpMetrics();
     private static final SemanticVersion VERSION = new SemanticVersion(0, 56, 0, "", "");
 
     private static final int NUM_ROUNDS = 10000;
@@ -100,6 +102,7 @@ public class StandaloneRoundManagement {
             UNAVAILABLE_GOSSIP,
             configProvider::getConfiguration,
             () -> DEFAULT_NODE_INFO,
+            () -> NO_OP_METRICS,
             (split, snapshots) -> {
                 throw new UnsupportedOperationException();
             });

diff --git a/hedera-node/hedera-app/src/main/java/com/hedera/node/app/Hedera.java b/hedera-node/hedera-app/src/main/java/com/hedera/node/app/Hedera.java
@@ -429,6 +429,7 @@ public Hedera(
                 this,
                 configSupplier,
                 () -> daggerApp.networkInfo().selfNodeInfo(),
+                () -> metrics,
                 new AppThrottleFactory(
                         configSupplier,
                         () -> daggerApp.workingStateAccessor().getState(),
@@ -602,6 +603,8 @@ public void onStateInitialized(
                     trigger,
                     RosterUtils.buildAddressBook(platform.getRoster()),
                     platform.getContext().getConfiguration());
+
+            contractServiceImpl.registerMetrics();
         }
         // With the States API grounded in the working state, we can create the object graph from it
         initializeDagger(state, trigger);

diff --git a/hedera-node/hedera-app/src/main/java/com/hedera/node/app/services/AppContextImpl.java b/hedera-node/hedera-app/src/main/java/com/hedera/node/app/services/AppContextImpl.java
@@ -20,6 +20,7 @@
 import com.hedera.node.app.spi.signatures.SignatureVerifier;
 import com.hedera.node.app.spi.throttle.Throttle;
 import com.swirlds.config.api.Configuration;
+import com.swirlds.metrics.api.Metrics;
 import com.swirlds.state.lifecycle.info.NodeInfo;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.time.InstantSource;
@@ -39,5 +40,6 @@ public record AppContextImpl(
         @NonNull Gossip gossip,
         @NonNull Supplier<Configuration> configSupplier,
         @NonNull Supplier<NodeInfo> selfNodeInfoSupplier,
+        @NonNull Supplier<Metrics> metricsSupplier,
         @NonNull Throttle.Factory throttleFactory)
         implements AppContext {}
diff --git a/...dera-app/src/main/java/com/hedera/node/app/workflows/standalone/TransactionExecutors.java b/...dera-app/src/main/java/com/hedera/node/app/workflows/standalone/TransactionExecutors.java
@@ -39,6 +39,7 @@
 import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.common.crypto.CryptographyHolder;
 import com.swirlds.common.metrics.noop.NoOpMetrics;
+import com.swirlds.metrics.api.Metrics;
 import com.swirlds.state.State;
 import com.swirlds.state.lifecycle.info.NodeInfo;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -111,6 +112,7 @@ private ExecutorComponent newExecutorComponent(
                 UNAVAILABLE_GOSSIP,
                 bootstrapConfigProvider::getConfiguration,
                 () -> DEFAULT_NODE_INFO,
+                () -> NO_OP_METRICS,
                 new AppThrottleFactory(
                         configProvider::getConfiguration,
                         () -> state,
@@ -122,7 +124,7 @@ private ExecutorComponent newExecutorComponent(
                 ForkJoinPool.commonPool(),
                 new TssLibraryImpl(appContext),
                 ForkJoinPool.commonPool(),
-                new NoOpMetrics());
+                NO_OP_METRICS);
         final var contractService = new ContractServiceImpl(appContext, NOOP_VERIFICATION_STRATEGIES, tracerBinding);
         final var fileService = new FileServiceImpl();
         final var scheduleService = new ScheduleServiceImpl();
@@ -133,7 +135,7 @@ private ExecutorComponent newExecutorComponent(
                 .fileServiceImpl(fileService)
                 .contractServiceImpl(contractService)
                 .scheduleServiceImpl(scheduleService)
-                .metrics(new NoOpMetrics())
+                .metrics(NO_OP_METRICS)
                 .throttleFactory(appContext.throttleFactory())
                 .build();
         componentRef.set(component);
@@ -159,4 +161,6 @@ public List<OperationTracer> get() {
             return OPERATION_TRACERS.get();
         }
     }
+
+    private static final Metrics NO_OP_METRICS = new NoOpMetrics();
 }
diff --git a/hedera-node/hedera-app/src/test/java/com/hedera/node/app/components/IngestComponentTest.java b/hedera-node/hedera-app/src/test/java/com/hedera/node/app/components/IngestComponentTest.java
@@ -101,6 +101,8 @@ class IngestComponentTest {
 
     private HederaInjectionComponent app;
 
+    private static final Metrics NO_OP_METRICS = new NoOpMetrics();
+
     @BeforeEach
     void setUp() {
         final Configuration configuration = HederaTestConfigBuilder.createConfig();
@@ -125,6 +127,7 @@ void setUp() {
                 UNAVAILABLE_GOSSIP,
                 () -> configuration,
                 () -> DEFAULT_NODE_INFO,
+                () -> NO_OP_METRICS,
                 throttleFactory);
         given(tssBaseService.tssHandlers())
                 .willReturn(new TssHandlers(tssMessageHandler, tssVoteHandler, tssShareSignatureHandler));

diff --git a/...-app/src/test/java/com/hedera/node/app/workflows/standalone/TransactionExecutorsTest.java b/...-app/src/test/java/com/hedera/node/app/workflows/standalone/TransactionExecutorsTest.java
@@ -250,6 +250,7 @@ private State genesisState(@NonNull final Map<String, String> overrides) {
                 UNAVAILABLE_GOSSIP,
                 () -> config,
                 () -> DEFAULT_NODE_INFO,
+                () -> NO_OP_METRICS,
                 new AppThrottleFactory(
                         () -> config, () -> state, () -> ThrottleDefinitions.DEFAULT, ThrottleAccumulator::new));
         registerServices(appContext, config, servicesRegistry);

diff --git a/hedera-node/hedera-config/src/main/java/com/hedera/node/config/data/ContractsConfig.java b/hedera-node/hedera-config/src/main/java/com/hedera/node/config/data/ContractsConfig.java
@@ -120,4 +120,8 @@ public record ContractsConfig(
                 boolean chargeGasOnEvmHandleException,
         @ConfigProperty(value = "evm.nonExtantContractsFail", defaultValue = "0") @NetworkProperty
                 Set<Long> evmNonExtantContractsFail,
-        @ConfigProperty(value = "evm.version", defaultValue = "v0.51") @NetworkProperty String evmVersion) {}
+        @ConfigProperty(value = "evm.version", defaultValue = "v0.51") @NetworkProperty String evmVersion,
+        @ConfigProperty(value = "metrics.smartContract.primary.enabled", defaultValue = "true") @NetworkProperty
+                boolean metricsSmartContractPrimaryEnabled,
+        @ConfigProperty(value = "metrics.smartContract.secondary.enabled", defaultValue = "true") @NetworkProperty
+                boolean metricsSmartContractSecondaryEnabled) {}
diff --git a/...mpl/src/main/java/com/hedera/node/app/service/contract/impl/ContractServiceComponent.java b/...mpl/src/main/java/com/hedera/node/app/service/contract/impl/ContractServiceComponent.java
@@ -16,6 +16,7 @@
 
 package com.hedera.node.app.service.contract.impl;
 
+import com.hedera.node.app.service.contract.impl.exec.metrics.ContractMetrics;
 import com.hedera.node.app.service.contract.impl.exec.scope.VerificationStrategies;
 import com.hedera.node.app.service.contract.impl.handlers.ContractHandlers;
 import com.hedera.node.app.spi.signatures.SignatureVerifier;
@@ -50,11 +51,17 @@ ContractServiceComponent create(
                 @BindsInstance InstantSource instantSource,
                 @BindsInstance SignatureVerifier signatureVerifier,
                 @BindsInstance VerificationStrategies verificationStrategies,
-                @BindsInstance @Nullable Supplier<List<OperationTracer>> addOnTracers);
+                @BindsInstance @Nullable Supplier<List<OperationTracer>> addOnTracers,
+                @BindsInstance ContractMetrics contractMetrics);
     }
 
     /**
      * @return all contract transaction handlers
      */
     ContractHandlers handlers();
+
+    /**
+     * @return contract metrics collection, instance
+     */
+    ContractMetrics contractMetrics();
 }
diff --git a/...ice-impl/src/main/java/com/hedera/node/app/service/contract/impl/ContractServiceImpl.java b/...ice-impl/src/main/java/com/hedera/node/app/service/contract/impl/ContractServiceImpl.java
@@ -19,12 +19,14 @@
 import static java.util.Objects.requireNonNull;
 
 import com.hedera.node.app.service.contract.ContractService;
+import com.hedera.node.app.service.contract.impl.exec.metrics.ContractMetrics;
 import com.hedera.node.app.service.contract.impl.exec.scope.DefaultVerificationStrategies;
 import com.hedera.node.app.service.contract.impl.exec.scope.VerificationStrategies;
 import com.hedera.node.app.service.contract.impl.handlers.ContractHandlers;
 import com.hedera.node.app.service.contract.impl.schemas.V0490ContractSchema;
 import com.hedera.node.app.service.contract.impl.schemas.V0500ContractSchema;
 import com.hedera.node.app.spi.AppContext;
+import com.hedera.node.config.data.ContractsConfig;
 import com.swirlds.state.lifecycle.SchemaRegistry;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -61,14 +63,19 @@ public ContractServiceImpl(
             @Nullable final VerificationStrategies verificationStrategies,
             @Nullable final Supplier<List<OperationTracer>> addOnTracers) {
         requireNonNull(appContext);
+        final var metricsSupplier = requireNonNull(appContext.metricsSupplier());
+        final Supplier<ContractsConfig> contractsConfigSupplier =
+                () -> appContext.configSupplier().get().getConfigData(ContractsConfig.class);
+        final var contractMetrics = new ContractMetrics(metricsSupplier, contractsConfigSupplier);
         this.component = DaggerContractServiceComponent.factory()
                 .create(
                         appContext.instantSource(),
                         // (FUTURE) Inject the signature verifier instance into the IsAuthorizedSystemContract
                         // C.f. https://github.com/hashgraph/hedera-services/issues/14248
                         appContext.signatureVerifier(),
                         Optional.ofNullable(verificationStrategies).orElseGet(DefaultVerificationStrategies::new),
-                        addOnTracers);
+                        addOnTracers,
+                        contractMetrics);
     }
 
     @Override
@@ -77,6 +84,14 @@ public void registerSchemas(@NonNull final SchemaRegistry registry) {
         registry.register(new V0500ContractSchema());
     }
 
+    /**
+     * Create the metrics for the smart contracts service. This needs to be delayed until _after_
+     * the metrics are available - which happens after `Hedera.initializeStatesApi`.
+     */
+    public void registerMetrics() {
+        component.contractMetrics().createContractMetrics();
+    }
+
     /**
      * @return all contract transaction handlers
      */