Package com.codahale.metrics
Class JmxReporter.Builder
- java.lang.Object
-
- com.codahale.metrics.JmxReporter.Builder
-
- Enclosing class:
- JmxReporter
public static class JmxReporter.Builder extends java.lang.Object
A builder forCsvReporter
instances. Defaults to using the default MBean server and not filtering metrics.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
domain
private java.util.concurrent.TimeUnit
durationUnit
private MetricFilter
filter
private javax.management.MBeanServer
mBeanServer
private java.util.concurrent.TimeUnit
rateUnit
private MetricRegistry
registry
private java.util.Map<java.lang.String,java.util.concurrent.TimeUnit>
specificDurationUnits
private java.util.Map<java.lang.String,java.util.concurrent.TimeUnit>
specificRateUnits
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder(MetricRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JmxReporter
build()
Builds aJmxReporter
with the given properties.JmxReporter.Builder
convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.JmxReporter.Builder
convertRatesTo(java.util.concurrent.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(java.lang.String domain)
JmxReporter.Builder
registerWith(javax.management.MBeanServer mBeanServer)
Register MBeans with the givenMBeanServer
.JmxReporter.Builder
specificDurationUnits(java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificDurationUnits)
Use specificTimeUnit
s for the duration of the metrics with these names.JmxReporter.Builder
specificRateUnits(java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificRateUnits)
Use specificTimeUnit
s for the rate of the metrics with these names.
-
-
-
Field Detail
-
registry
private final MetricRegistry registry
-
mBeanServer
private javax.management.MBeanServer mBeanServer
-
rateUnit
private java.util.concurrent.TimeUnit rateUnit
-
durationUnit
private java.util.concurrent.TimeUnit durationUnit
-
filter
private MetricFilter filter
-
domain
private java.lang.String domain
-
specificDurationUnits
private java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificDurationUnits
-
specificRateUnits
private java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificRateUnits
-
-
Constructor Detail
-
Builder
private Builder(MetricRegistry registry)
-
-
Method Detail
-
registerWith
public JmxReporter.Builder registerWith(javax.management.MBeanServer mBeanServer)
Register MBeans with the givenMBeanServer
.- Parameters:
mBeanServer
- anMBeanServer
- Returns:
this
-
convertRatesTo
public JmxReporter.Builder convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.- Parameters:
rateUnit
- a unit of time- Returns:
this
-
convertDurationsTo
public JmxReporter.Builder convertDurationsTo(java.util.concurrent.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
- aMetricFilter
- Returns:
this
-
inDomain
public JmxReporter.Builder inDomain(java.lang.String domain)
-
specificDurationUnits
public JmxReporter.Builder specificDurationUnits(java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificDurationUnits)
Use specificTimeUnit
s for the duration of the metrics with these names.- Parameters:
specificDurationUnits
- a map of metric names and specificTimeUnit
s- Returns:
this
-
specificRateUnits
public JmxReporter.Builder specificRateUnits(java.util.Map<java.lang.String,java.util.concurrent.TimeUnit> specificRateUnits)
Use specificTimeUnit
s for the rate of the metrics with these names.- Parameters:
specificRateUnits
- a map of metric names and specificTimeUnit
s- Returns:
this
-
build
public JmxReporter build()
Builds aJmxReporter
with the given properties.- Returns:
- a
JmxReporter
-
-