You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by dw...@apache.org on 2021/03/10 09:59:53 UTC
[lucene] 40/50: Ref Guide: copy edit metrics updates;
change param presentation format
This is an automated email from the ASF dual-hosted git repository.
dweiss pushed a commit to branch branch_7_1
in repository https://gitbox.apache.org/repos/asf/lucene.git
commit 98bf0cde266ce7aad1176764d37a3ff82cf1a226
Author: Cassandra Targett <ct...@apache.org>
AuthorDate: Thu Oct 26 14:57:37 2017 -0500
Ref Guide: copy edit metrics updates; change param presentation format
---
solr/solr-ref-guide/src/metrics-reporting.adoc | 121 +++++++++++++++++--------
1 file changed, 85 insertions(+), 36 deletions(-)
diff --git a/solr/solr-ref-guide/src/metrics-reporting.adoc b/solr/solr-ref-guide/src/metrics-reporting.adoc
index 451f93e..f7d173c 100644
--- a/solr/solr-ref-guide/src/metrics-reporting.adoc
+++ b/solr/solr-ref-guide/src/metrics-reporting.adoc
@@ -178,17 +178,30 @@ This example configures two reporters: <<Graphite Reporter,Graphite>> and <<SLF4
Reporter plugins use the following arguments:
-* *name* - (required) unique name of the reporter plugin
-* *class* - (required) fully-qualified implementation class of the plugin, must extend `SolrMetricReporter`
-* *group* - (optional) one or more of the predefined groups (see above)
-* *registry* - (optional) one or more of valid fully-qualified registry names
-* If both `group` and `registry` attributes are specified only the `group` attribute is considered. If neither attribute is specified then the plugin will be used for all groups and registries. Multiple group or registry names can be specified, separated by comma and/or space.
+`name`::
+The unique name of the reporter plugin (required).
+
+`class`::
+The fully-qualified implementation class of the plugin, which must extend `SolrMetricReporter` (required).
+
+`group`::
+One or more of the predefined groups (see above).
+
+`registry`::
+One or more of valid fully-qualified registry names.
+
+If both `group` and `registry` attributes are specified only the `group` attribute is considered. If neither attribute is specified then the plugin will be used for all groups and registries. Multiple group or registry names can be specified, separated by comma and/or space.
Additionally, several implementation-specific initialization arguments can be specified in nested elements. There are some arguments that are common to SLF4J, Ganglia and Graphite reporters:
-* *period* - (optional int) period in seconds between reports. Default value is 60.
-* *prefix* - (optional str) prefix to be added to metric names, may be helpful in logical grouping of related Solr instances, e.g., machine name or cluster name. Default is empty string, i.e., just the registry name and metric name will be used to form a fully-qualified metric name.
-* *filter* - (optional str) if not empty then only metric names that start with this value will be reported. Default is no filtering, i.e., all metrics from selected registry will be reported.
+`period`::
+The period in seconds between reports. Default value is `60`.
+
+`prefix`::
+A prefix to be added to metric names, which may be helpful in logical grouping of related Solr instances, e.g., machine name or cluster name. Default is empty string, i.e., just the registry name and metric name will be used to form a fully-qualified metric name.
+
+`filter`::
+If not empty then only metric names that start with this value will be reported. Default is no filtering, i.e., all metrics from the selected registry will be reported.
Reporters are instantiated for every group and registry that they were configured for, at the time when the respective components are initialized (e.g., on JVM startup or SolrCore load).
@@ -204,9 +217,14 @@ The JMX Reporter uses the `org.apache.solr.metrics.reporters.SolrJmxReporter` cl
It takes the following arguments:
-* *domain* - (optional string) JMX domain name. If not specified then the registry name will be used.
-* *serviceUrl* - (optional string) The service URL for a JMX server. If not specified, Solr will attempt to discover if the JVM has an MBean server and will use that address. See below for additional information on this.
-* *agentId* - (optional string) The agent ID for a JMX server. Note either `serviceUrl` or `agentId` can be specified but not both - if both are specified then the default MBean server will be used.
+`domain`::
+The JMX domain name. If not specified then the registry name will be used.
+
+`serviceUrl`::
+The service URL for a JMX server. If not specified, Solr will attempt to discover if the JVM has an MBean server and will use that address. See below for additional information on this.
+
+`agentId`::
+The agent ID for a JMX server. Note either `serviceUrl` or `agentId` can be specified but not both - if both are specified then the default MBean server will be used.
Object names created by this reporter are hierarchical, dot-separated but also properly structured to form corresponding hierarchies in e.g., JConsole. This hierarchy consists of the following elements in the top-down order:
@@ -225,7 +243,8 @@ The SLF4J Reporter uses the `org.apache.solr.metrics.reporters.SolrSlf4jReporter
It takes the following arguments, in addition to the common arguments <<Reporter Arguments,above>>.
-* *logger* - (optional str) name of the logger to use. Default is empty, in which case the group or registry name will be used if specified in the plugin configuration.
+`logger`::
+The name of the logger to use. Default is empty, in which case the group or registry name will be used if specified in the plugin configuration.
Users can specify logger name (and the corresponding logger configuration in e.g., Log4j configuration) to output metrics-related logging to separate file(s), which can then be processed by external applications.
@@ -252,9 +271,13 @@ The http://graphiteapp.org[Graphite] Reporter uses the `org.apache.solr.metrics.
It takes the following attributes, in addition to the common attributes <<Reporter Arguments,above>>.
-* *host* - (required str) host name where Graphite server is running.
-* *port* - (required int) port number for the server
-* *pickled* - (optional bool) use "pickled" Graphite protocol which may be more efficient. Default is false (use plain-text protocol).
+`host`::
+The host name where Graphite server is running (required).
+
+`port`::
+The port number for the server (required).
+`pickled`::
+If `true`, use "pickled" Graphite protocol which may be more efficient. Default is `false` (use plain-text protocol).
When plain-text protocol is used (`pickled==false`) it's possible to use this reporter to integrate with systems other than Graphite, if they can accept space-separated and line-oriented input over network in the following format:
@@ -282,9 +305,14 @@ The http://ganglia.info[Ganglia] reporter uses the `org.apache.solr.metrics.repo
It take the following arguments, in addition to the common arguments <<Reporter Arguments,above>>.
-* *host* - (required str) host name where Ganglia server is running.
-* *port* - (required int) port number for the server
-* *multicast* - (optional bool) when true use multicast UDP communication, otherwise use UDP unicast. Default is false.
+`host`::
+The host name where Ganglia server is running (required).
+
+`port`::
+The port number for the server.
+
+`multicast`::
+When `true` use multicast UDP communication, otherwise use UDP unicast. Default is `false`.
=== Shard and Cluster Reporters
These two reporters can be used for aggregation of metrics reported from replicas to shard leader (the "shard" reporter),
@@ -299,7 +327,7 @@ and re-reported elsewhere as necessary.
In case of shard reporter the target node is the shard leader, in case of cluster reporter the
target node is the Overseer leader.
-=== Shard Reporter
+==== Shard Reporter
This reporter uses predefined `shard` group, and the implementing class must be (a subclass of)
`solr.SolrShardReporter`. It publishes selected metrics from replicas to the node where shard leader is
located. Reports use a target registry name that is the replica's registry name with a `.leader` suffix, e.g., for a
@@ -308,12 +336,18 @@ SolrCore name `collection1_shard1_replica_n3` the target registry name is
The following configuration properties are supported:
-* *handler* - (optional str) handler path where reports are sent. Default is `/admin/metrics/collector`.
-* *period* - (optional int) how often reports are sent, in seconds. Default is 60. Setting this to 0 disables the reporter.
-* *filter* - (optional multiple str) regex expression(s) matching selected metrics to be reported.
+`handler`::
+The handler path where reports are sent. Default is `/admin/metrics/collector`.
+
+`period`::
+How often reports are sent, in seconds. Default is `60`. Setting this to `0` disables the reporter.
+`filter`::
+An optional regular expression(s) matching selected metrics to be reported.
++
The following filter expressions are used by default:
-[source]
++
+[source,text]
----
TLOG.*
CORE\.fs.*
@@ -334,27 +368,39 @@ Example configuration:
</reporter>
----
-=== Cluster Reporter
+==== Cluster Reporter
This reporter uses predefined `cluster` group and the implementing class must be (a subclass of)
`solr.SolrClusterReporter`. It publishes selected metrics from any local registry to the Overseer leader node.
The following configuration properties are supported:
-* *handler* - (optional str) handler path where reports are sent. Default is `/admin/metrics/collector`.
-* *period* - (optional int) how often reports are sent, in seconds. Default is 60. Setting this to 0 disables the reporter.
-* *report* - (optional multiple lst) report configuration(s), see below.
+`handler`::
+The handler path where reports are sent. Default is `/admin/metrics/collector`.
+
+`period`::
+How often reports are sent, in seconds. Default is `60`. Setting this to `0` disables the reporter.
+
+`report`::
+report configuration(s), see below.
+
+Each report configuration consists of the following properties:
-Each report configuration consist of the following properties:
+`registry`::
+A regular expression pattern matching local source registries (see `SolrMetricManager.registryNames(String...)`), may contain regex capture groups (required).
-* *registry* - (required str) regex pattern matching local source registries (see `SolrMetricManager.registryNames(String...)`), may contain regex capture groups.
-* *group* - (required str) target registry name where metrics will be grouped. This can be a regex pattern that contains back-references to capture groups collected by registry pattern
-* *label* - (optional str) optional prefix to prepend to metric names, may contain back-references to capture groups collected by registry pattern
-* *filter* - (optional multiple str) regex expression(s) matching selected metrics to be reported.
+`group`::
+The target registry name where metrics will be grouped. This can be a regular expression pattern that contains back-references to capture groups collected by registry pattern (required).
+
+`label`::
+An optional prefix to prepend to metric names, may contain back-references to capture groups collected by registry pattern.
+
+`filter`::
+An optional regular expression(s) matching selected metrics to be reported.
The following report specifications are used by default (their result is a single additional metric registry in Overseer, called
`solr.cluster`):
-[source]
+[source,xml]
----
<lst name="report">
<str name="group">cluster</str>
@@ -537,12 +583,15 @@ Like other request handlers, the Metrics API can also take the `wt` parameter to
Request only "counter" type metrics in the "core" group, returned in JSON:
-`\http://localhost:8983/solr/admin/metrics?type=counter&group=core`
+[source,text]
+http://localhost:8983/solr/admin/metrics?type=counter&group=core
Request only "core" group metrics that start with "INDEX", returned in XML:
-`\http://localhost:8983/solr/admin/metrics?wt=xml&prefix=INDEX&group=core`
+[source,text]
+http://localhost:8983/solr/admin/metrics?wt=xml&prefix=INDEX&group=core
Request only "user.name" property of "system.properties" metric from registry "solr.jvm":
-`\http://localhost:8983/solr/admin/metrics?wt=xml?key=solr.jvm:system.properties:user.name`
+[source,text]
+http://localhost:8983/solr/admin/metrics?wt=xml?key=solr.jvm:system.properties:user.name