org.apache.solr.metrics.reporters

Class SolrJmxReporter

java.lang.Object

org.apache.solr.metrics.SolrMetricReporter

org.apache.solr.metrics.reporters.SolrJmxReporter

All Implemented Interfaces:

Closeable, AutoCloseable, PluginInfoInitialized

public class SolrJmxReporter
extends SolrMetricReporter

A SolrMetricReporter that finds (or creates) a MBeanServer from the given configuration and registers metrics to it with JMX.

NOTE: JmxReporter that this class uses exports only newly added metrics (it doesn't process already existing metrics in a registry)

Field Summary

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

enabled, metricManager, pluginInfo, registryName

Constructor Summary

Constructors

Constructor and Description
SolrJmxReporter(SolrMetricManager metricManager, String registryName) Creates a new instance of SolrJmxReporter.

Method Summary

Modifier and Type	Method and Description
void	close() Stops the reporter from publishing metrics.
String	getAgentId() Return configured agentId or null.
String	getDomain() Return configured domain or null.
MBeanServer	getMBeanServer() Return the reporter's MBeanServer.
String	getServiceUrl() Return configured serviceUrl or null.
void	init(PluginInfo pluginInfo) Initializes the reporter by finding an MBeanServer and registering the metricManager's metric registry.
boolean	isActive() For unit tests.
void	setAgentId(String agentId) Sets the agent id for a JMX server.
void	setDomain(String domain) Sets the domain with which MBeans are published.
void	setFilter(List<String> filters) Report only metrics with names matching any of the prefix filters.
void	setFilter(String filter)
void	setRootName(String rootName) Set root name of the JMX hierarchy for this reporter.
void	setServiceUrl(String serviceUrl) Sets the service url for a JMX server.
String	toString()
protected void	validate() Validates that the reporter has been correctly configured.

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

getPluginInfo, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrJmxReporter

public SolrJmxReporter(SolrMetricManager metricManager,
                       String registryName)

Creates a new instance of SolrJmxReporter.

Parameters:

registryName - name of the registry to report

Method Detail

init

public void init(PluginInfo pluginInfo)

Initializes the reporter by finding an MBeanServer and registering the metricManager's metric registry.

Specified by:

init in interface PluginInfoInitialized

Overrides:

init in class SolrMetricReporter

Parameters:

pluginInfo - the configuration for the reporter

close

public void close()

Stops the reporter from publishing metrics.

validate

protected void validate()
                 throws IllegalStateException

Validates that the reporter has been correctly configured. Note that all configurable arguments are currently optional.

Specified by:

validate in class SolrMetricReporter

Throws:

IllegalStateException - if the reporter is not properly configured

setRootName

public void setRootName(String rootName)

Set root name of the JMX hierarchy for this reporter. Default (null or empty) is none, ie. the hierarchy will start from the domain name.

Parameters:

rootName - root name of the JMX name hierarchy, or null or empty for default.

setDomain

public void setDomain(String domain)

Sets the domain with which MBeans are published. If none is set, the domain defaults to the name of the registry.

Parameters:

domain - the domain

setServiceUrl

public void setServiceUrl(String serviceUrl)

Sets the service url for a JMX server. Note that this configuration is optional.

Parameters:

serviceUrl - the service url

setAgentId

public void setAgentId(String agentId)

Sets the agent id for a JMX server. Note that this configuration is optional.

Parameters:

agentId - the agent id

getAgentId

public String getAgentId()

Return configured agentId or null.

getServiceUrl

public String getServiceUrl()

Return configured serviceUrl or null.

getDomain

public String getDomain()

Return configured domain or null.

setFilter

public void setFilter(List<String> filters)

Report only metrics with names matching any of the prefix filters.

Parameters:

filters - list of 0 or more prefixes. If the list is empty then all names will match.

setFilter

public void setFilter(String filter)

getMBeanServer

public MBeanServer getMBeanServer()

Return the reporter's MBeanServer.

Returns:

the reporter's MBeanServer

isActive

public boolean isActive()

For unit tests.

Returns:

true if this reporter is actively reporting metrics to JMX.

toString

public String toString()

Overrides:

toString in class SolrMetricReporter