Package org.apache.solr.metrics.reporters.jmx

Class JmxMetricsReporter.Builder

java.lang.Object

org.apache.solr.metrics.reporters.jmx.JmxMetricsReporter.Builder

Enclosing class:

JmxMetricsReporter

public static class JmxMetricsReporter.Builder
extends Object

Builder for the JmxMetricsReporter class.

Method Summary

Modifier and Type	Method	Description
JmxMetricsReporter	build()
JmxMetricsReporter.Builder	convertDurationsTo(TimeUnit durationUnit)	Convert durations to the given time unit.
JmxMetricsReporter.Builder	convertRatesTo(TimeUnit rateUnit)	Convert rates to the given time unit.
JmxMetricsReporter.Builder	createsObjectNamesWith(com.codahale.metrics.jmx.ObjectNameFactory onFactory)
JmxMetricsReporter.Builder	filter(com.codahale.metrics.MetricFilter filter)	Only report metrics which match the given filter.
JmxMetricsReporter.Builder	inDomain(String domain)
JmxMetricsReporter.Builder	registerWith(MBeanServer mBeanServer)	Register MBeans with the given MBeanServer.
JmxMetricsReporter.Builder	withTag(String tag)

Methods inherited from class java.lang.Object

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

Method Detail

registerWith

public JmxMetricsReporter.Builder registerWith(MBeanServer mBeanServer)

Register MBeans with the given MBeanServer.

Parameters:

mBeanServer - an MBeanServer

Returns:

this

convertRatesTo

public JmxMetricsReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

createsObjectNamesWith

public JmxMetricsReporter.Builder createsObjectNamesWith(com.codahale.metrics.jmx.ObjectNameFactory onFactory)

convertDurationsTo

public JmxMetricsReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public JmxMetricsReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

inDomain

public JmxMetricsReporter.Builder inDomain(String domain)

withTag

public JmxMetricsReporter.Builder withTag(String tag)

build

public JmxMetricsReporter build()