org.apache.solr.metrics.reporters.solr

Class SolrShardReporter

java.lang.Object

org.apache.solr.metrics.SolrMetricReporter

org.apache.solr.metrics.FilteringSolrMetricReporter

org.apache.solr.metrics.SolrCoreReporter

org.apache.solr.metrics.reporters.solr.SolrShardReporter

All Implemented Interfaces:

Closeable, AutoCloseable, PluginInfoInitialized

public class SolrShardReporter
extends SolrCoreReporter

This class reports selected metrics from replicas to shard leader.

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.
• filter - (optional multiple str) regex expression(s) matching selected metrics to be reported.

NOTE: this reporter uses predefined "shard" group, and it's always created even if explicit configuration is missing. Default configuration uses filters defined in DEFAULT_FILTERS.

Example configuration:

    <reporter name="test" group="shard" class="solr.SolrShardReporter">
      <int name="period">11</int>
      <str name="filter">UPDATE\./update/.*requests</str>
      <str name="filter">QUERY\./select.*requests</str>
    </reporter>
 

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	DEFAULT_FILTERS

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

core

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

filters

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

enabled, metricManager, period, pluginInfo, registryName

Constructor Summary

Constructors

Constructor and Description
SolrShardReporter(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, SolrCore core)
protected com.codahale.metrics.MetricFilter	newMetricFilter() Report only metrics with names matching any of the prefix filters.
void	setHandler(String handler)
protected void	validate() Validates that the reporter has been correctly configured.

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

getCore, init

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

setFilter, setFilter

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

DEFAULT_FILTERS

public static final List<String> DEFAULT_FILTERS

Constructor Detail

SolrShardReporter

public SolrShardReporter(SolrMetricManager metricManager,
                         String registryName)

Create a reporter for metrics managed in a named registry.

Parameters:

metricManager - metric manager

registryName - registry to use, one of registries managed by SolrMetricManager

Method Detail

setHandler

public void setHandler(String handler)

doInit

protected void doInit()

Description copied from class: SolrMetricReporter

Reporter initialization implementation.

Specified by:

doInit in class SolrMetricReporter

newMetricFilter

protected com.codahale.metrics.MetricFilter newMetricFilter()

Description copied from class: FilteringSolrMetricReporter

Report only metrics with names matching any of the prefix filters. If the filters list is empty then all names will match.

Overrides:

newMetricFilter in class FilteringSolrMetricReporter

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,
                 SolrCore core)

Overrides:

init in class SolrCoreReporter