org.apache.solr.metrics.reporters

Class SolrSlf4jReporter

java.lang.Object

org.apache.solr.metrics.SolrMetricReporter

org.apache.solr.metrics.reporters.SolrSlf4jReporter

All Implemented Interfaces:

Closeable, AutoCloseable, PluginInfoInitialized

public class SolrSlf4jReporter
extends SolrMetricReporter

Metrics reporter that wraps Slf4jReporter. The following init arguments are supported:

• period: (optional, int) number of seconds between reports, default is 60,
• prefix: (optional, str) prefix for metric names, in addition to registry name. Default is none, ie. just registry name.
• filter: (optional, str) if not empty only metric names that start with this value will be reported, default is all metrics from a registry,
• logger: (optional, str) logger name to use. Default is the metrics group, eg. solr.jvm

Field Summary

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

metricManager, pluginInfo, registryName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
void	setFilter(String filter)
void	setLogger(String logger)
void	setPeriod(int period)
void	setPrefix(String prefix)
protected void	validate() Validates that the reporter has been correctly configured.

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

getPluginInfo, init, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrSlf4jReporter

public SolrSlf4jReporter(SolrMetricManager metricManager,
                         String registryName)

Create a SLF4J reporter for metrics managed in a named registry.

Parameters:

metricManager - metric manager instance that manages the selected registry

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

Method Detail

setPrefix

public void setPrefix(String prefix)

setFilter

public void setFilter(String filter)

setLogger

public void setLogger(String logger)

setPeriod

public void setPeriod(int period)

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