Package com.codahale.metrics

Class JmxReporter.Builder

java.lang.Object

com.codahale.metrics.JmxReporter.Builder

Enclosing class:

JmxReporter

public static class JmxReporter.Builder
extends Object

A builder for CsvReporter instances. Defaults to using the default MBean server and not filtering metrics.

Field Summary

Fields

Modifier and Type	Field	Description
private String	domain
private TimeUnit	durationUnit
private MetricFilter	filter
private MBeanServer	mBeanServer
private TimeUnit	rateUnit
private final MetricRegistry	registry
private Map<String,TimeUnit>	specificDurationUnits
private Map<String,TimeUnit>	specificRateUnits

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
JmxReporter	build()	Builds a JmxReporter with the given properties.
JmxReporter.Builder	convertDurationsTo(TimeUnit durationUnit)	Convert durations to the given time unit.
JmxReporter.Builder	convertRatesTo(TimeUnit rateUnit)	Convert rates to the given time unit.
JmxReporter.Builder	filter(MetricFilter filter)	Only report metrics which match the given filter.
JmxReporter.Builder	inDomain(String domain)
JmxReporter.Builder	registerWith(MBeanServer mBeanServer)	Register MBeans with the given MBeanServer.
JmxReporter.Builder	specificDurationUnits(Map<String,TimeUnit> specificDurationUnits)	Use specific TimeUnits for the duration of the metrics with these names.
JmxReporter.Builder	specificRateUnits(Map<String,TimeUnit> specificRateUnits)	Use specific TimeUnits for the rate of the metrics with these names.

Methods inherited from class java.lang.Object

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

Field Details

registry

private final MetricRegistry registry

mBeanServer

private MBeanServer mBeanServer

rateUnit

private TimeUnit rateUnit

durationUnit

private TimeUnit durationUnit

filter

private MetricFilter filter

domain

private String domain

specificDurationUnits

private Map<String,TimeUnit> specificDurationUnits

specificRateUnits

private Map<String,TimeUnit> specificRateUnits

Constructor Details

Builder

private Builder(MetricRegistry registry)

Method Details

registerWith

public JmxReporter.Builder registerWith(MBeanServer mBeanServer)

Register MBeans with the given MBeanServer.

Parameters:

mBeanServer - an MBeanServer

Returns:

this

convertRatesTo

public JmxReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public JmxReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public JmxReporter.Builder filter(MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

inDomain

public JmxReporter.Builder inDomain(String domain)

specificDurationUnits

public JmxReporter.Builder specificDurationUnits(Map<String,TimeUnit> specificDurationUnits)

Use specific TimeUnits for the duration of the metrics with these names.

Parameters:

specificDurationUnits - a map of metric names and specific TimeUnits

Returns:

this

specificRateUnits

public JmxReporter.Builder specificRateUnits(Map<String,TimeUnit> specificRateUnits)

Use specific TimeUnits for the rate of the metrics with these names.

Parameters:

specificRateUnits - a map of metric names and specific TimeUnits

Returns:

this

build

public JmxReporter build()

Builds a JmxReporter with the given properties.

Returns:

a JmxReporter