lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctarg...@apache.org
Subject lucene-solr:master: SOLR-10280: document "compact" format of metrics response
Date Fri, 02 Jun 2017 17:36:25 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/master 3618fc529 -> 3b45d8284


SOLR-10280: document "compact" format of metrics response


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

Branch: refs/heads/master
Commit: 3b45d8284fed203eba146d98662485eb7a31364c
Parents: 3618fc5
Author: Cassandra Targett <ctargett@apache.org>
Authored: Fri Jun 2 12:34:22 2017 -0500
Committer: Cassandra Targett <ctargett@apache.org>
Committed: Fri Jun 2 12:36:19 2017 -0500

----------------------------------------------------------------------
 solr/solr-ref-guide/src/metrics-reporting.adoc | 52 +++++++++++++++++++--
 1 file changed, 49 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/3b45d828/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 6da87b5..63fdbf3 100644
--- a/solr/solr-ref-guide/src/metrics-reporting.adoc
+++ b/solr/solr-ref-guide/src/metrics-reporting.adoc
@@ -262,9 +262,55 @@ The `admin/metrics` endpoint provides access to all the metrics for all
metric g
 
 A few query parameters are available to limit the request:
 
-* *group*: The metric group to retrieve. The default is `all` to retrieve all metrics for
all groups. Other possible values are: `jvm`, `jetty`, `node`, and `core`. More than one group
can be specified in a request; multiple group names should be separated by a comma.
-* *type*: The type of metric to retrieve. The default is `all` to retrieve all metric types.
Other possible values are `counter`, `gauge`, `histogram`, `meter`, and `timer`. More than
one type can be specified in a request; multiple types should be separated by a comma.
-* *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.
+group:: The metric group to retrieve. The default is `all` to retrieve all metrics for all
groups. Other possible values are: `jvm`, `jetty`, `node`, and `core`. More than one group
can be specified in a request; multiple group names should be separated by a comma.
+
+type:: The type of metric to retrieve. The default is `all` to retrieve all metric types.
Other possible values are `counter`, `gauge`, `histogram`, `meter`, and `timer`. More than
one type can be specified in a request; multiple types should be separated by a comma.
+
+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.
+
+compact:: When true, a more compact format of the response will be returned. Instead of a
response like this:
++
+[source,json]
+  "metrics": [
+    "solr.core.gettingstarted",
+    {
+      "CORE.aliases": {
+        "value": ["gettingstarted"]
+      },
+      "CORE.coreName": {
+        "value": "gettingstarted"
+      },
+      "CORE.indexDir": {
+        "value": "/solr/example/schemaless/solr/gettingstarted/data/index/"
+      },
+      "CORE.instanceDir": {
+        "value": "/solr/example/schemaless/solr/gettingstarted"
+      },
+      "CORE.refCount": {
+        "value": 1
+      },
+      "CORE.startTime": {
+        "value": "2017-03-14T11:43:23.822Z"
+      }
+    }
+  ]
++
+The response will look like this:
++
+[source,json]
+  "metrics": [
+    "solr.core.gettingstarted",
+    {
+      "CORE.aliases": [
+        "gettingstarted"
+      ],
+      "CORE.coreName": "gettingstarted",
+      "CORE.indexDir": "/solr/example/schemaless/solr/gettingstarted/data/index/",
+      "CORE.instanceDir": "/solr/example/schemaless/solr/gettingstarted",
+      "CORE.refCount": 1,
+      "CORE.startTime": "2017-03-14T11:43:23.822Z"
+    }
+  ]
 
 Like other request handlers, the Metrics API can also take the `wt` parameter to define the
output format.
 


Mime
View raw message