Add a new metric turms.client.request.pending to record the number of pending requests

Author: JamesChenX

turms-gateway/src/main/java/im/turms/gateway/access/client/common/ClientRequestDispatcher.java

@@ -17,11 +17,14 @@
 
 package im.turms.gateway.access.client.common;
 
+import java.util.concurrent.atomic.AtomicInteger;
+
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import org.springframework.stereotype.Component;
 import reactor.core.publisher.Mono;
 
+import im.turms.gateway.domain.observation.service.MetricsService;
 import im.turms.gateway.domain.servicerequest.service.ServiceRequestService;
 import im.turms.gateway.domain.session.access.client.controller.SessionClientController;
 import im.turms.gateway.domain.session.service.SessionService;
@@ -43,6 +46,7 @@
 import im.turms.server.common.infra.healthcheck.ServiceAvailability;
 import im.turms.server.common.infra.logging.core.logger.Logger;
 import im.turms.server.common.infra.logging.core.logger.LoggerFactory;
+import im.turms.server.common.infra.metrics.CommonMetricNameConst;
 import im.turms.server.common.infra.property.TurmsPropertiesManager;
 import im.turms.server.common.infra.proto.ProtoDecoder;
 import im.turms.server.common.infra.proto.ProtoEncoder;
@@ -84,6 +88,8 @@ public class ClientRequestDispatcher {
     private final ServiceRequestService serviceRequestService;
     private final ServerStatusManager serverStatusManager;
 
+    private final AtomicInteger pendingRequestCount;
+
     public ClientRequestDispatcher(
             ApiLoggingContext apiLoggingContext,
             BlocklistService blocklistService,
@@ -92,6 +98,7 @@ public ClientRequestDispatcher(
             SessionService sessionService,
             ServiceRequestService serviceRequestService,
             ServerStatusManager serverStatusManager,
+            MetricsService metricsService,
             TurmsPropertiesManager propertiesManager) {
         this.apiLoggingContext = apiLoggingContext;
         this.blocklistService = blocklistService;
@@ -100,6 +107,8 @@ public ClientRequestDispatcher(
         this.sessionService = sessionService;
         this.serviceRequestService = serviceRequestService;
         this.serverStatusManager = serverStatusManager;
+        pendingRequestCount = metricsService.getRegistry()
+                .gauge(CommonMetricNameConst.TURMS_CLIENT_REQUEST_PENDING, new AtomicInteger());
         NotificationFactory.init(propertiesManager);
     }
 
@@ -113,6 +122,19 @@ public ClientRequestDispatcher(
     public Mono<ByteBuf> handleRequest(
             UserSessionWrapper sessionWrapper,
             ByteBuf serviceRequestBuffer) {
+        pendingRequestCount.incrementAndGet();
+        try {
+            return handleRequest0(sessionWrapper, serviceRequestBuffer)
+                    .doFinally(signalType -> pendingRequestCount.decrementAndGet());
+        } catch (Exception e) {
+            pendingRequestCount.decrementAndGet();
+            return Mono.error(e);
+        }
+    }
+
+    public Mono<ByteBuf> handleRequest0(
+            UserSessionWrapper sessionWrapper,
+            ByteBuf serviceRequestBuffer) {
         // Check if it is a heartbeat request
         if (!serviceRequestBuffer.isReadable()) {
             serviceRequestBuffer.release();

turms-service/src/main/java/im/turms/service/access/servicerequest/dispatcher/ServiceRequestDispatcher.java

@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
+import java.util.concurrent.atomic.AtomicInteger;
 import jakarta.annotation.Nullable;
 import jakarta.validation.constraints.NotNull;
 
@@ -65,6 +66,7 @@
 import im.turms.server.common.infra.tracing.TracingContext;
 import im.turms.service.access.servicerequest.dto.ClientRequest;
 import im.turms.service.access.servicerequest.dto.RequestHandlerResult;
+import im.turms.service.domain.observation.service.MetricsService;
 import im.turms.service.infra.logging.ApiLoggingContext;
 import im.turms.service.infra.logging.ClientApiLogging;
 import im.turms.service.infra.plugin.extension.ClientRequestTransformer;
@@ -98,6 +100,8 @@ public class ServiceRequestDispatcher implements IServiceRequestDispatcher {
 
     private final FastEnumMap<TurmsRequest.KindCase, ClientRequestHandler> requestTypeToHandler;
 
+    private final AtomicInteger pendingRequestCount;
+
     static {
         try {
             REQUEST_TRANSFORM_METHOD = ClientRequestTransformer.class.getDeclaredMethod("transform",
@@ -124,6 +128,7 @@ public ServiceRequestDispatcher(
             ApiLoggingContext apiLoggingContext,
             ApplicationContext context,
             BlocklistService blocklistService,
+            MetricsService metricsService,
             OutboundMessageManager outboundMessageManager,
             ServerStatusManager serverStatusManager,
             PluginManager pluginManager,
@@ -147,6 +152,8 @@ public ServiceRequestDispatcher(
                                 + requestType);
             }
         }
+        pendingRequestCount = metricsService.getRegistry()
+                .gauge(TURMS_CLIENT_REQUEST_PENDING, new AtomicInteger());
     }
 
     private FastEnumMap<TurmsRequest.KindCase, ClientRequestHandler> getMappings(
@@ -194,10 +201,13 @@ private boolean isRequestForGateway(TurmsRequest.KindCase type) {
     @Override
     public Mono<ServiceResponse> dispatch(TracingContext context, ServiceRequest serviceRequest) {
         ByteBuf requestBuffer = serviceRequest.getTurmsRequestBuffer();
+        pendingRequestCount.incrementAndGet();
         try {
             requestBuffer.touch(serviceRequest);
-            return dispatch0(context, serviceRequest);
+            return dispatch0(context, serviceRequest)
+                    .doFinally(unused -> pendingRequestCount.decrementAndGet());
         } catch (Exception e) {
+            pendingRequestCount.decrementAndGet();
             LOGGER.error("Failed to handle the request: {}", serviceRequest, e);
             return Mono.just(
                     ServiceResponse.of(ResponseStatusCode.SERVER_INTERNAL_ERROR, e.toString()));