Added the metrics to keep track for requests failed and received.

HarshSawarkar · HarshSawarkar · commit da27095f41f7 · 2025-03-11T14:33:21.000+05:30
Signed-off-by: Harsh Sawarkar &lt;harshsawarkar111@gmail.com&gt;
diff --git a/server/src/main/java/com/hedera/block/server/BlockNodeApp.java b/server/src/main/java/com/hedera/block/server/BlockNodeApp.java
@@ -66,7 +66,7 @@ public BlockNodeApp(
         this.pbjBlockStreamService = requireNonNull(pbjBlockStreamService);
         this.pbjBlockAccessService = requireNonNull(pbjBlockAccessService);
         this.webServerBuilder = requireNonNull(webServerBuilder);
-        this.pbjServerStatusService = pbjServerStatusService;
+        this.pbjServerStatusService = requireNonNull(pbjServerStatusService);
         this.serverConfig = requireNonNull(serverConfig);
         this.configurationLogging = requireNonNull(configurationLogging);
     }
diff --git a/server/src/main/java/com/hedera/block/server/Constants.java b/server/src/main/java/com/hedera/block/server/Constants.java
@@ -12,6 +12,7 @@ public final class Constants {
     /** Constant mapped to the name of the BlockAccess service in the .proto file */
     public static final String SERVICE_NAME_BLOCK_ACCESS = "BlockAccessService";
 
+    /** Constant mapped to the name of the BlockNode service in the .proto file */
     public static final String SERVICE_NAME_BLOCK_NODE = "BlockNodeService";
 
     /** Constant representing the service domain */
@@ -23,6 +24,7 @@ public final class Constants {
     /** Constant mapped to the full name of the BlockAccess service */
     public static final String FULL_SERVICE_NAME_BLOCK_ACCESS = SERVICE_DOMAIN + SERVICE_NAME_BLOCK_ACCESS;
 
+    /** Constant mapped to the full name of the BlockNode service */
     public static final String FULL_SERVICE_NAME_BLOCK_NODE = SERVICE_DOMAIN + SERVICE_NAME_BLOCK_NODE;
 
     /** Constant defining the block file extension */
diff --git a/server/src/main/java/com/hedera/block/server/metrics/BlockNodeMetricTypes.java b/server/src/main/java/com/hedera/block/server/metrics/BlockNodeMetricTypes.java
@@ -26,6 +26,12 @@ public enum Counter implements MetricMetadata {
         /** The number of live block items received before publishing to the RingBuffer. */
         LiveBlockItems("live_block_items", "Live BlockItems"),
 
+        /** The number of requests received by the ServerStatus API */
+        RequestsReceived("requests_received", "Total Requests Received by ServerStatus API"),
+
+        /** The number of errors encountered while handling requests */
+        RequestsFailed("requests_failed", "Total Requests Failed in ServerStatus API"),
+
         /** The number of PublishStreamResponses generated and published to the subscribers. */
         SuccessfulPubStreamResp("successful_pub_stream_resp", "Successful Publish Stream Responses"),
 
diff --git a/server/src/main/java/com/hedera/block/server/pbj/PbjServerStatusService.java b/server/src/main/java/com/hedera/block/server/pbj/PbjServerStatusService.java
@@ -9,21 +9,48 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * The PbjServerStatusService interface provides type definitions and default method
+ * implementations for PBJ to route gRPC requests to the server status service.
+ */
 public interface PbjServerStatusService extends ServiceInterface {
+
+    /**
+     * ServerStatusMethod types define the gRPC methods available on the ServerStatusService.
+     */
     enum ServerStatusMethod implements Method {
+        /**
+         * The serverStatus method represents the unary gRPC method
+         * consumers should use to retrieve the status of the Block Node.
+         */
         serverStatus
     }
 
+    /**
+     * Provides the service name of the ServerStatusService.
+     *
+     * @return the service name of the ServerStatusService.
+     */
     @NonNull
     default String serviceName() {
         return SERVICE_NAME_BLOCK_NODE;
     }
 
+    /**
+     * Provides the full name of the ServerStatusService.
+     *
+     * @return the full name of the ServerStatusService.
+     */
     @NonNull
     default String fullName() {
         return FULL_SERVICE_NAME_BLOCK_NODE;
     }
 
+    /**
+     * Provides the list of methods available in the ServerStatusService.
+     *
+     * @return the list of available methods in the ServerStatusService.
+     */
     @NonNull
     default List<Method> methods() {
         return Arrays.asList(PbjServerStatusService.ServerStatusMethod.values());
diff --git a/server/src/main/java/com/hedera/block/server/pbj/PbjServerStatusServiceProxy.java b/server/src/main/java/com/hedera/block/server/pbj/PbjServerStatusServiceProxy.java
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 package com.hedera.block.server.pbj;
 
+import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.RequestsFailed;
+import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.RequestsReceived;
 import static java.lang.System.Logger.Level.DEBUG;
 import static java.lang.System.Logger.Level.ERROR;
 
 import com.hedera.block.server.metrics.MetricsService;
-import com.hedera.block.server.persistence.storage.read.BlockReader;
 import com.hedera.block.server.service.ServiceStatus;
-import com.hedera.hapi.block.BlockUnparsed;
 import com.hedera.hapi.block.ServerStatusRequest;
 import com.hedera.hapi.block.ServerStatusResponse;
 import com.hedera.pbj.runtime.ParseException;
@@ -16,31 +16,28 @@
 import com.hedera.pbj.runtime.grpc.Pipelines;
 import com.hedera.pbj.runtime.io.buffer.Bytes;
 import edu.umd.cs.findbugs.annotations.NonNull;
+import java.util.Objects;
 import javax.inject.Inject;
 
 public class PbjServerStatusServiceProxy implements PbjServerStatusService {
 
     private final System.Logger LOGGER = System.getLogger(getClass().getName());
 
     private final ServiceStatus serviceStatus;
-    private final BlockReader<BlockUnparsed> blockReader;
     private final MetricsService metricsService;
 
     /**
      * Creates a new PbjBlockAccessServiceProxy instance.
      *
      * @param serviceStatus the service status
-     * @param blockReader the block reader
+     * //     * @param blockReader the block reader
      * @param metricsService the metrics service
      */
     @Inject
     public PbjServerStatusServiceProxy(
-            @NonNull final ServiceStatus serviceStatus,
-            @NonNull final BlockReader<BlockUnparsed> blockReader,
-            @NonNull final MetricsService metricsService) {
-        this.serviceStatus = serviceStatus;
-        this.blockReader = blockReader;
-        this.metricsService = metricsService;
+            @NonNull final ServiceStatus serviceStatus, @NonNull final MetricsService metricsService) {
+        this.serviceStatus = Objects.requireNonNull(serviceStatus);
+        this.metricsService = Objects.requireNonNull(metricsService);
     }
 
     @NonNull
@@ -71,15 +68,16 @@ private Bytes createServerStatusResponse(@NonNull final ServerStatusResponse ser
 
     ServerStatusResponse serverStatus(ServerStatusRequest serverStatusRequest) {
         LOGGER.log(DEBUG, "Executing Unary serverStatus gRPC method");
-
         if (serviceStatus.isRunning()) {
+            metricsService.get(RequestsReceived).increment();
             return ServerStatusResponse.newBuilder()
                     .firstAvailableBlock(serviceStatus.getFirstAvailableBlockNumber())
                     .lastAvailableBlock(serviceStatus.getLatestReceivedBlockNumber())
                     .onlyLatestState(serviceStatus.getOnlyLatestState())
                     .versionInformation(serviceStatus.getVersionInformation())
                     .build();
         } else {
+            metricsService.get(RequestsFailed).increment();
             LOGGER.log(ERROR, "Unary serverStatus gRPC method is not currently running");
 
             return ServerStatusResponse.newBuilder().build();
diff --git a/server/src/main/java/com/hedera/block/server/service/ServiceStatus.java b/server/src/main/java/com/hedera/block/server/service/ServiceStatus.java
@@ -86,11 +86,31 @@ public interface ServiceStatus {
      */
     void setFirstAvailableBlockNumber(long firstAvailableBlockNumber);
 
+    /**
+     * Checks if only the latest state should be maintained.
+     *
+     * @return true if only the latest state is maintained, false otherwise.
+     */
     boolean getOnlyLatestState();
 
+    /**
+     * Sets whether only the latest state should be maintained.
+     *
+     * @param onlyLatestState true to maintain only the latest state, false otherwise.
+     */
     void setOnlyLatestState(boolean onlyLatestState);
 
+    /**
+     * Retrieves the version information of the Block Node.
+     *
+     * @return the {@link BlockNodeVersions} containing version details.
+     */
     BlockNodeVersions getVersionInformation();
 
+    /**
+     * Sets the version information of the Block Node.
+     *
+     * @param versionInformation the {@link BlockNodeVersions} containing version details.
+     */
     void setVersionInformation(BlockNodeVersions versionInformation);
 }
diff --git a/server/src/test/java/com/hedera/block/server/BlockNodeAppTest.java b/server/src/test/java/com/hedera/block/server/BlockNodeAppTest.java
@@ -101,7 +101,7 @@ void setup() throws IOException {
                         consumerConfig,
                         producerConfig),
                 new PbjBlockAccessServiceProxy(serviceStatus, blockReader, metricsService),
-                new PbjServerStatusServiceProxy(serviceStatus, blockReader, metricsService),
+                new PbjServerStatusServiceProxy(serviceStatus, metricsService),
                 webServerBuilder,
                 serverConfig,
                 configurationLogging);
diff --git a/server/src/test/java/com/hedera/block/server/metrics/MetricsServiceTest.java b/server/src/test/java/com/hedera/block/server/metrics/MetricsServiceTest.java
@@ -4,6 +4,7 @@
 import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.BlocksPersisted;
 import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.LiveBlockItems;
 import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.LiveBlockItemsConsumed;
+import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.RequestsReceived;
 import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Counter.SingleBlocksRetrieved;
 import static com.hedera.block.server.metrics.BlockNodeMetricTypes.Gauge.Consumers;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -56,6 +57,21 @@ void MetricsService_verifyLiveBlockItemsCounter() {
         assertEquals(10, metricsService.get(LiveBlockItems).get());
     }
 
+    @Test
+    void MetricsService_verifyRequestsReceivedCounter() {
+        for (int i = 0; i < 5; i++) {
+            metricsService.get(RequestsReceived).increment();
+        }
+
+        assertEquals(
+                RequestsReceived.grafanaLabel(),
+                metricsService.get(RequestsReceived).getName());
+        assertEquals(
+                RequestsReceived.description(),
+                metricsService.get(RequestsReceived).getDescription());
+        assertEquals(5, metricsService.get(RequestsReceived).get());
+    }
+
     @Test
     void MetricsService_verifyBlocksPersistedCounter() {
 
diff --git a/server/src/test/java/com/hedera/block/server/pbj/PbjServerStatusServiceProxyTest.java b/server/src/test/java/com/hedera/block/server/pbj/PbjServerStatusServiceProxyTest.java
@@ -52,8 +52,7 @@ public void setUp() throws IOException {
 
     @Test
     public void testServerStatus() {
-        final PbjServerStatusServiceProxy serviceProxy =
-                new PbjServerStatusServiceProxy(serviceStatus, blockReader, metricsService);
+        final PbjServerStatusServiceProxy serviceProxy = new PbjServerStatusServiceProxy(serviceStatus, metricsService);
 
         Pipeline<? super Bytes> pipeline =
                 serviceProxy.open(PbjServerStatusService.ServerStatusMethod.serverStatus, options, replies);
@@ -88,8 +87,7 @@ public void testServerStatus() {
 
     @Test
     public void testServerStatusWhenNotRunning() {
-        final PbjServerStatusServiceProxy serviceProxy =
-                new PbjServerStatusServiceProxy(serviceStatus, blockReader, metricsService);
+        final PbjServerStatusServiceProxy serviceProxy = new PbjServerStatusServiceProxy(serviceStatus, metricsService);
 
         Pipeline<? super Bytes> pipeline =
                 serviceProxy.open(PbjServerStatusService.ServerStatusMethod.serverStatus, options, replies);

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public BlockNodeApp(`
`66`	`66`	`this.pbjBlockStreamService = requireNonNull(pbjBlockStreamService);`
`67`	`67`	`this.pbjBlockAccessService = requireNonNull(pbjBlockAccessService);`
`68`	`68`	`this.webServerBuilder = requireNonNull(webServerBuilder);`
`69`		`- this.pbjServerStatusService = pbjServerStatusService;`
	`69`	`+ this.pbjServerStatusService = requireNonNull(pbjServerStatusService);`
`70`	`70`	`this.serverConfig = requireNonNull(serverConfig);`
`71`	`71`	`this.configurationLogging = requireNonNull(configurationLogging);`
`72`	`72`	`}`