Andrzej Bialecki created SOLR-10509:
----------------------------------------
Summary: Document changes in SOLR-10418
Key: SOLR-10509
URL: https://issues.apache.org/jira/browse/SOLR-10509
Project: Solr
Issue Type: Task
Security Level: Public (Default Security Level. Issues are Public)
Components: documentation
Affects Versions: master (7.0)
Reporter: Andrzej Bialecki
SOLR-10418 added system properties to the metrics API, together with some other
changes that should be documented:
* {{solr.jvm}} metrics group now contains a compound metric (ie. a metric that
has several mixed-type properties) named {{system.properties}}. This metric
exposes most of key/value pairs from {{System.getProperties()}}, except for
some properties that are considered sensitive.
* a new optional element {{/metrics/hiddenSysProps}} is now supported in
{{solr.xml}} config file. It can be used for declaring what system properties
are considered sensitive and should not be exposed via metrics API. If this
element is absent a default list of hidden properties is used, equivalent to
the following configuration:
{code}
<solr>
...
<metrics>
<hiddenSysProps>
<str>javax.net.ssl.keyStorePassword</str>
<str>javax.net.ssl.trustStorePassword</str>
<str>basicauth</str>
<str>zkDigestPassword</str>
<str>zkDigestReadonlyPassword</str>
</hiddenSysProps>
...
</metrics>
</solr>
{code}
* {{/admin/metrics}} handler now supports a {{property}} parameter that can be
used for selecting a specific property from a compound metric. Multiple
{{property}} parameters can be specified, which will act as a logical OR. For
example, parameters
{{prefix=system.properties&property=user.home&property=user.name}} would return
just the two specified system properties. This property selection mechanism
works also for other types of metrics that have multiple properties (eg.
timers, meters, histograms, etc), for example {{property=p99&property=p99_ms}}
will return only the 99-th percentile value from all selected histograms and
timers.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
