[2/2] lucene-solr:branch_7x: SOLR-11778: Docs for per-stage metrics, and the missing "regex" parameter docs.

[ab...@apache.org]

SOLR-11778: Docs for per-stage metrics, and the missing "regex" parameter docs.


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/7fbdf5d2
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/7fbdf5d2
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/7fbdf5d2

Branch: refs/heads/branch_7x
Commit: 7fbdf5d2038ce2c94759ca5c9cb21ad45f6eb02b
Parents: 32ca792
Author: Andrzej Bialecki <ab...@apache.org>
Authored: Fri Feb 2 14:28:27 2018 +0100
Committer: Andrzej Bialecki <ab...@apache.org>
Committed: Fri Feb 2 14:30:24 2018 +0100

----------------------------------------------------------------------
 solr/solr-ref-guide/src/metrics-reporting.adoc | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/7fbdf5d2/solr/solr-ref-guide/src/metrics-reporting.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/metrics-reporting.adoc b/solr/solr-ref-guide/src/metrics-reporting.adoc
index 5454712..d9b4c5f 100644
--- a/solr/solr-ref-guide/src/metrics-reporting.adoc
+++ b/solr/solr-ref-guide/src/metrics-reporting.adoc
@@ -64,7 +64,9 @@ This registry is returned at `solr.node` and includes the following information.
 
 The <<Core Level Metrics,Core (SolrCore) Registry>> includes `solr.core.<collection>`, one for each core. When making requests with the <<Metrics API>>, you can specify `&group=core` to limit to only these metrics.
 
-* all common RequestHandler-s report: request timers / counters, timeouts, errors.
+* all common RequestHandler-s report: request timers / counters, timeouts, errors. Handlers that support
+  process distributed shard requests also report `shardRequests` sub-counters for each type of distributed
+  request.
 * <<Index Merge Metrics,index-level events>>: meters for minor / major merges, number of merged docs, number of deleted docs, gauges for currently running merges and their size.
 * shard replication and transaction log replay on replicas (TBD, SOLR-9856)
 * open / available / pending connections for shard handler and update handler
@@ -518,6 +520,9 @@ type:: The type of metric to retrieve. The default is `all` to retrieve all metr
 
 prefix:: The first characters of metric name that will filter the metrics returned to those starting with the provided string. It can be combined with `group` and/or `type` parameters. More than one prefix can be specified in a request; multiple prefixes should be separated by a comma. Prefix matching is also case-sensitive.
 
+regex:: A regular expression matching metric names. Note: dot separators in metric names must be escaped, eg.
+`QUERY\./select\..*` is a valid regex that matches all metrics with the `QUERY./select.` prefix.
+
 property:: Allows requesting only this metric from any compound metric. Multiple `property` parameters can be combined to act as an OR request. For example, to only get the 99th and 999th percentile values from all metric types and groups, you can add `&property=p99_ms&property=p999_ms` to your request. This can be combined with `group`, `type`, and `prefix` as necessary.
 
 key:: fully-qualified metric name, which specifies one concrete metric instance (parameter can be
@@ -589,6 +594,11 @@ Request only "core" group metrics that start with "INDEX", returned in XML:
 [source,text]
 http://localhost:8983/solr/admin/metrics?wt=xml&prefix=INDEX&group=core
 
+Request only "core" group metrics that end with ".requests":
+
+[source,text]
+http://localhost:8983/solr/admin/metrics?regex=.*\.requests&group=core
+
 Request only "user.name" property of "system.properties" metric from registry "solr.jvm":
 
 [source,text]