org.apache.solr.metrics.reporters.solr

Class SolrClusterReporter

java.lang.Object

org.apache.solr.metrics.SolrMetricReporter

org.apache.solr.metrics.SolrCoreContainerReporter

org.apache.solr.metrics.reporters.solr.SolrClusterReporter

All Implemented Interfaces:

Closeable, AutoCloseable, PluginInfoInitialized

public class SolrClusterReporter
extends SolrCoreContainerReporter

This reporter sends selected metrics from local registries to Overseer.

The following configuration properties are supported:

• handler - (optional str) handler path where reports are sent. Default is MetricsCollectorHandler.HANDLER_PATH.
• 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.

Each report configuration consist of the following properties:

• registry - (required str) regex pattern matching source registries (see SolrMetricManager.registryNames(String...)), may contain 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.

NOTE: this reporter uses predefined "cluster" group, and it's always created even if explicit configuration is missing. Default configuration uses report specifications from DEFAULT_REPORTS.

Example configuration:

       <reporter name="test" group="cluster" class="solr.SolrClusterReporter">
         <str name="handler">/admin/metrics/collector</str>
         <int name="period">11</int>
         <lst name="report">
           <str name="group">overseer</str>
           <str name="label">jvm</str>
           <str name="registry">solr\.jvm</str>
           <str name="filter">memory\.total\..*</str>
           <str name="filter">memory\.heap\..*</str>
           <str name="filter">os\.SystemLoadAverage</str>
           <str name="filter">threads\.count</str>
         </lst>
         <lst name="report">
           <str name="group">overseer</str>
           <str name="label">leader.$1</str>
           <str name="registry">solr\.core\.(.*)\.leader</str>
           <str name="filter">UPDATE\./update/.*</str>
         </lst>
       </reporter>
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_GROUP
static List<SolrReporter.Report>	DEFAULT_REPORTS

Fields inherited from class org.apache.solr.metrics.SolrCoreContainerReporter

coreContainer

Fields inherited from class org.apache.solr.metrics.SolrMetricReporter

enabled, metricManager, period, pluginInfo, registryName

Constructor Summary

Constructors

Constructor and Description
SolrClusterReporter(SolrMetricManager metricManager, String registryName) Create a reporter for metrics managed in a named registry.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doInit() Reporter initialization implementation.
void	init(PluginInfo pluginInfo, CoreContainer cc)
void	setHandler(String handler)
void	setReport(List<Map> reportConfig)
void	setReport(Map map)
protected void	validate() Validates that the reporter has been correctly configured.

Methods inherited from class org.apache.solr.metrics.SolrCoreContainerReporter

getCoreContainer, init

Methods inherited from class org.apache.solr.metrics.SolrMetricReporter

getPeriod, getPluginInfo, setEnabled, setPeriod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLUSTER_GROUP

public static final String CLUSTER_GROUP

DEFAULT_REPORTS

public static final List<SolrReporter.Report> DEFAULT_REPORTS

Constructor Detail

SolrClusterReporter

public SolrClusterReporter(SolrMetricManager metricManager,
                           String registryName)

Create a reporter for metrics managed in a named registry.

Parameters:

metricManager - metric manager

registryName - this is ignored

Method Detail

setHandler

public void setHandler(String handler)

setReport

public void setReport(List<Map> reportConfig)

setReport

public void setReport(Map map)

doInit

protected void doInit()

Description copied from class: SolrMetricReporter

Reporter initialization implementation.

Specified by:

doInit in class SolrMetricReporter

validate

protected void validate()
                 throws IllegalStateException

Description copied from class: SolrMetricReporter

Validates that the reporter has been correctly configured.

Specified by:

validate in class SolrMetricReporter

Throws:

IllegalStateException - if the reporter is not properly configured

close

public void close()
           throws IOException

Throws:

IOException

init

public void init(PluginInfo pluginInfo,
                 CoreContainer cc)

Overrides:

init in class SolrCoreContainerReporter