SOLR-11778 Add per-stage RequestHandler metrics.

solr/CHANGES.txt

@@ -153,6 +153,8 @@ New Features
   sorting/faceting just like StrField.  By default uses only the first 1024 chars of the original
   input string values, but this is configurable.  (hossman)
 
+* SOLR-11778: Add per-stage RequestHandler metrics. (ab)
+
 Bug Fixes
 ----------------------
 

solr/core/src/java/org/apache/solr/handler/RequestHandlerBase.java

@@ -18,6 +18,7 @@ package org.apache.solr.handler;
 
 import java.lang.invoke.MethodHandles;
 import java.util.Collection;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -27,12 +28,14 @@ import com.codahale.metrics.Counter;
 import com.codahale.metrics.Meter;
 import com.codahale.metrics.Timer;
 import org.apache.solr.common.SolrException;
+import org.apache.solr.common.params.ShardParams;
 import org.apache.solr.common.params.SolrParams;
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.common.util.SuppressForbidden;
 import org.apache.solr.core.PluginBag;
 import org.apache.solr.core.PluginInfo;
 import org.apache.solr.core.SolrInfoBean;
+import org.apache.solr.metrics.MetricsMap;
 import org.apache.solr.metrics.SolrMetricManager;
 import org.apache.solr.metrics.SolrMetricProducer;
 import org.apache.solr.request.SolrQueryRequest;
@@ -65,6 +68,7 @@ public abstract class RequestHandlerBase implements SolrRequestHandler, SolrInfo
   private Meter numClientErrors = new Meter();
   private Meter numTimeouts = new Meter();
   private Counter requests = new Counter();
+  private final Map<String, Counter> shardPurposes = new ConcurrentHashMap<>();
   private Timer requestTimes = new Timer();
   private Counter totalTime = new Counter();
 
@@ -77,6 +81,7 @@ public abstract class RequestHandlerBase implements SolrRequestHandler, SolrInfo
   private Set<String> metricNames = ConcurrentHashMap.newKeySet();
   private MetricRegistry registry;
 
+
   @SuppressForbidden(reason = "Need currentTimeMillis, used only for stats output")
   public RequestHandlerBase() {
     handlerStart = System.currentTimeMillis();
@@ -139,13 +144,16 @@ public abstract class RequestHandlerBase implements SolrRequestHandler, SolrInfo
   }
 
   @Override
-  public void initializeMetrics(SolrMetricManager manager, String registryName, String scope) {
+  public void initializeMetrics(SolrMetricManager manager, String registryName, final String scope) {
     registry = manager.registry(registryName);
     numErrors = manager.meter(this, registryName, "errors", getCategory().toString(), scope);
     numServerErrors = manager.meter(this, registryName, "serverErrors", getCategory().toString(), scope);
     numClientErrors = manager.meter(this, registryName, "clientErrors", getCategory().toString(), scope);
     numTimeouts = manager.meter(this, registryName, "timeouts", getCategory().toString(), scope);
     requests = manager.counter(this, registryName, "requests", getCategory().toString(), scope);
+    MetricsMap metricsMap = new MetricsMap((detail, map) ->
+      shardPurposes.forEach((k, v) -> map.put(k, v.getCount())));
+    manager.register(this, registryName, metricsMap, true, "shardRequests", getCategory().toString(), scope);
     requestTimes = manager.timer(this, registryName, "requestTimes", getCategory().toString(), scope);
     totalTime = manager.counter(this, registryName, "totalTime", getCategory().toString(), scope);
     manager.registerGauge(this, registryName, () -> handlerStart, true, "handlerStart", getCategory().toString(), scope);
@@ -168,6 +176,16 @@ public abstract class RequestHandlerBase implements SolrRequestHandler, SolrInfo
   @Override
   public void handleRequest(SolrQueryRequest req, SolrQueryResponse rsp) {
     requests.inc();
+    if (req.getParams().getBool(ShardParams.IS_SHARD, false)) {
+      shardPurposes.computeIfAbsent("total", name -> new Counter()).inc();
+      int purpose = req.getParams().getInt(ShardParams.SHARDS_PURPOSE, 0);
+      if (purpose != 0) {
+        String[] names = SolrPluginUtils.getRequestPurposeNames(purpose);
+        for (String n : names) {
+          shardPurposes.computeIfAbsent(n, name -> new Counter()).inc();
+        }
+      }
+    }
     Timer.Context timer = requestTimes.time();
     try {
       if(pluginInfo != null && pluginInfo.attributes.containsKey(USEPARAM)) req.getContext().put(USEPARAM,pluginInfo.attributes.get(USEPARAM));

solr/core/src/java/org/apache/solr/util/SolrPluginUtils.java

@@ -1072,6 +1072,41 @@ public class SolrPluginUtils {
       return UNKNOWN_VALUE;
   }
 
+  private static final String[] purposeUnknown = new String[] { UNKNOWN_VALUE };
+
+  /**
+   * Given the integer purpose of a request generates a readable value corresponding
+   * the request purposes (there can be more than one on a single request). If
+   * there is a purpose parameter present that's not known this method will
+   * return a 1-element array containing {@value #UNKNOWN_VALUE}
+   * @param reqPurpose Numeric request purpose
+   * @return an array of purpose names.
+   */
+  public static String[] getRequestPurposeNames(Integer reqPurpose) {
+    if (reqPurpose != null) {
+      int valid = 0;
+      for (Map.Entry<Integer, String>entry : purposes.entrySet()) {
+        if ((reqPurpose & entry.getKey()) != 0) {
+          valid++;
+        }
+      }
+      if (valid == 0) {
+        return purposeUnknown;
+      } else {
+        String[] result = new String[valid];
+        int i = 0;
+        for (Map.Entry<Integer, String>entry : purposes.entrySet()) {
+          if ((reqPurpose & entry.getKey()) != 0) {
+            result[i] = entry.getValue();
+            i++;
+          }
+        }
+        return result;
+      }
+    }
+    return purposeUnknown;
+  }
+
 }