feat(metric): add metric for json-rpc

Author: halibobo1205

common/src/main/java/org/tron/common/prometheus/MetricKeys.java

@@ -44,6 +44,7 @@ private Gauge() {
   public static class Histogram {
     public static final String HTTP_SERVICE_LATENCY = "tron:http_service_latency_seconds";
     public static final String GRPC_SERVICE_LATENCY = "tron:grpc_service_latency_seconds";
+    public static final String JSONRPC_SERVICE_LATENCY = "tron:jsonrpc_service_latency_seconds";
     public static final String MINER_LATENCY = "tron:miner_latency_seconds";
     public static final String PING_PONG_LATENCY = "tron:ping_pong_latency_seconds";
     public static final String VERIFY_SIGN_LATENCY = "tron:verify_sign_latency_seconds";

common/src/main/java/org/tron/common/prometheus/MetricsHistogram.java

@@ -17,6 +17,8 @@ public class MetricsHistogram {
         "url");
     init(MetricKeys.Histogram.GRPC_SERVICE_LATENCY, "Grpc Service latency.",
         "endpoint");
+    init(MetricKeys.Histogram.JSONRPC_SERVICE_LATENCY, "JsonRpc Service latency.",
+        "method");
     init(MetricKeys.Histogram.MINER_LATENCY, "miner latency.",
         "miner");
     init(MetricKeys.Histogram.PING_PONG_LATENCY, "node  ping pong  latency.");

framework/src/main/java/org/tron/core/services/jsonrpc/JsonRpcServlet.java

@@ -1,16 +1,19 @@
 package org.tron.core.services.jsonrpc;
 
 import com.googlecode.jsonrpc4j.HttpStatusCodeProvider;
+import com.googlecode.jsonrpc4j.JsonRpcInterceptor;
 import com.googlecode.jsonrpc4j.JsonRpcServer;
 import com.googlecode.jsonrpc4j.ProxyUtil;
 import java.io.IOException;
+import java.util.Collections;
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
+import org.tron.common.parameter.CommonParameter;
 import org.tron.core.Wallet;
 import org.tron.core.db.Manager;
 import org.tron.core.services.NodeInfoService;
@@ -29,6 +32,9 @@ public class JsonRpcServlet extends RateLimiterServlet {
   @Autowired
   private Manager manager;
 
+  @Autowired
+  private JsonRpcInterceptor interceptor;
+
   @Override
   public void init(ServletConfig config) throws ServletException {
     super.init(config);
@@ -57,6 +63,9 @@ public Integer getJsonRpcCode(int httpStatusCode) {
     rpcServer.setHttpStatusCodeProvider(httpStatusCodeProvider);
 
     rpcServer.setShouldLogInvocationErrors(false);
+    if (CommonParameter.getInstance().isMetricsPrometheusEnable()) {
+      rpcServer.setInterceptorList(Collections.singletonList(interceptor));
+    }
   }
 
   @Override

framework/src/main/java/org/tron/core/services/jsonrpc/interceptor/MetricInterceptor.java

@@ -0,0 +1,42 @@
+package org.tron.core.services.jsonrpc.interceptor;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.googlecode.jsonrpc4j.JsonRpcInterceptor;
+import com.googlecode.jsonrpc4j.ProxyUtil;
+import io.prometheus.client.Histogram;
+import java.lang.reflect.Method;
+import java.util.List;
+import org.springframework.stereotype.Component;
+import org.tron.common.prometheus.MetricKeys;
+import org.tron.common.prometheus.Metrics;
+
+@Component
+public class MetricInterceptor implements JsonRpcInterceptor {
+
+  private final ThreadLocal<Histogram.Timer> timer = new ThreadLocal<>();
+
+  @Override
+  public void preHandleJson(JsonNode json) {
+
+  }
+
+  @Override
+  public void preHandle(Object target, Method method, List<JsonNode> params) {
+    timer.set(Metrics.histogramStartTimer(MetricKeys.Histogram.JSONRPC_SERVICE_LATENCY,
+        ProxyUtil.getMethodName(method)));
+  }
+
+  @Override
+  public void postHandle(Object target, Method method, List<JsonNode> params, JsonNode result) {
+    try {
+      Metrics.histogramObserve(timer.get());
+    } finally {
+      timer.remove();
+    }
+  }
+
+  @Override
+  public void postHandleJson(JsonNode json) {
+
+  }
+}

framework/src/main/java/org/tron/core/services/jsonrpc/types/BlockResult.java

@@ -84,6 +84,10 @@ public class BlockResult {
   @Setter
   private String mixHash = ByteArray.toJsonHex(new byte[32]);
 
+  public BlockResult() {
+
+  }
+
   public BlockResult(Block block, boolean fullTx, Wallet wallet) {
     BlockCapsule blockCapsule = new BlockCapsule(block);
 

framework/src/test/java/org/tron/core/jsonrpc/JsonrpcServiceTest.java

@@ -1,13 +1,25 @@
 package org.tron.core.jsonrpc;
 
+import com.alibaba.fastjson.JSON;
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
 import com.google.protobuf.ByteString;
+import io.prometheus.client.CollectorRegistry;
 import javax.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.util.EntityUtils;
 import org.bouncycastle.util.encoders.Hex;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.tron.common.BaseTest;
+import org.tron.common.parameter.CommonParameter;
+import org.tron.common.prometheus.Metrics;
 import org.tron.common.utils.ByteArray;
 import org.tron.common.utils.Sha256Hash;
 import org.tron.core.Constant;
@@ -17,6 +29,7 @@
 import org.tron.core.capsule.TransactionCapsule;
 import org.tron.core.config.args.Args;
 import org.tron.core.services.NodeInfoService;
+import org.tron.core.services.jsonrpc.FullNodeJsonRpcHttpService;
 import org.tron.core.services.jsonrpc.TronJsonRpcImpl;
 import org.tron.core.services.jsonrpc.types.BlockResult;
 import org.tron.core.services.jsonrpc.types.TransactionResult;
@@ -39,9 +52,15 @@ public class JsonrpcServiceTest extends BaseTest {
   @Resource
   private Wallet wallet;
 
+  @Resource
+  private FullNodeJsonRpcHttpService fullNodeJsonRpcHttpService;
+
   static {
     dbPath = "output_jsonrpc_service_test";
     Args.setParam(new String[]{"--output-directory", dbPath}, Constant.TEST_CONF);
+    CommonParameter.getInstance().setJsonRpcHttpFullNodeEnable(true);
+    CommonParameter.getInstance().setMetricsPrometheusEnable(true);
+    Metrics.init();
 
     OWNER_ADDRESS =
         Wallet.getAddressPreFixString() + "abd4b9367799eaa3197fecb144eb71de1e049abc";
@@ -235,4 +254,40 @@ public void testGetTransactionByHash() {
         transactionResult.getBlockNumber());
   }
 
-}
+  @Test
+  public void testGetBlockByNumber2() {
+    fullNodeJsonRpcHttpService.start();
+    JsonArray params = new JsonArray();
+    params.add(ByteArray.toJsonHex(blockCapsule.getNum()));
+    params.add(false);
+    JsonObject requestBody = new JsonObject();
+    requestBody.addProperty("jsonrpc", "2.0");
+    requestBody.addProperty("method", "eth_getBlockByNumber");
+    requestBody.add("params", params);
+    requestBody.addProperty("id", 1);
+    CloseableHttpResponse response;
+    try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
+      HttpPost httpPost = new HttpPost("http://127.0.0.1:8545/jsonrpc");
+      httpPost.addHeader("Content-Type", "application/json");
+      httpPost.setEntity(new StringEntity(requestBody.toString()));
+      response = httpClient.execute(httpPost);
+      String resp = EntityUtils.toString(response.getEntity());
+      BlockResult blockResult = JSON.parseObject(resp).getObject("result", BlockResult.class);
+      Assert.assertEquals(ByteArray.toJsonHex(blockCapsule.getNum()),
+          blockResult.getNumber());
+      Assert.assertEquals(blockCapsule.getTransactions().size(),
+          blockResult.getTransactions().length);
+      Assert.assertEquals("0x0000000000000000",
+          blockResult.getNonce());
+      response.close();
+      Assert.assertEquals(1, CollectorRegistry.defaultRegistry.getSampleValue(
+          "tron:jsonrpc_service_latency_seconds_count",
+          new String[] {"method"}, new String[] {"eth_getBlockByNumber"}).intValue());
+    } catch (Exception e) {
+      Assert.fail(e.getMessage());
+    } finally {
+      fullNodeJsonRpcHttpService.stop();
+    }
+  }
+
+}