Package com.codahale.metrics.graphite
Class GraphiteReporter.Builder
- java.lang.Object
-
- com.codahale.metrics.graphite.GraphiteReporter.Builder
-
- Enclosing class:
- GraphiteReporter
public static class GraphiteReporter.Builder extends java.lang.Object
A builder forGraphiteReporter
instances. Defaults to not using a prefix, using the default clock, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.
-
-
Field Summary
Fields Modifier and Type Field Description private Clock
clock
private java.util.concurrent.TimeUnit
durationUnit
private MetricFilter
filter
private java.lang.String
prefix
private java.util.concurrent.TimeUnit
rateUnit
private MetricRegistry
registry
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder(MetricRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GraphiteReporter
build(Graphite graphite)
Builds aGraphiteReporter
with the given properties, sending metrics using the givenGraphite
client.GraphiteReporter.Builder
convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.GraphiteReporter.Builder
convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.GraphiteReporter.Builder
filter(MetricFilter filter)
Only report metrics which match the given filter.GraphiteReporter.Builder
prefixedWith(java.lang.String prefix)
Prefix all metric names with the given string.GraphiteReporter.Builder
withClock(Clock clock)
Use the givenClock
instance for the time.
-
-
-
Field Detail
-
registry
private final MetricRegistry registry
-
clock
private Clock clock
-
prefix
private java.lang.String prefix
-
rateUnit
private java.util.concurrent.TimeUnit rateUnit
-
durationUnit
private java.util.concurrent.TimeUnit durationUnit
-
filter
private MetricFilter filter
-
-
Constructor Detail
-
Builder
private Builder(MetricRegistry registry)
-
-
Method Detail
-
withClock
public GraphiteReporter.Builder withClock(Clock clock)
Use the givenClock
instance for the time.- Parameters:
clock
- aClock
instance- Returns:
this
-
prefixedWith
public GraphiteReporter.Builder prefixedWith(java.lang.String prefix)
Prefix all metric names with the given string.- Parameters:
prefix
- the prefix for all metric names- Returns:
this
-
convertRatesTo
public GraphiteReporter.Builder convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.- Parameters:
rateUnit
- a unit of time- Returns:
this
-
convertDurationsTo
public GraphiteReporter.Builder convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.- Parameters:
durationUnit
- a unit of time- Returns:
this
-
filter
public GraphiteReporter.Builder filter(MetricFilter filter)
Only report metrics which match the given filter.- Parameters:
filter
- aMetricFilter
- Returns:
this
-
build
public GraphiteReporter build(Graphite graphite)
Builds aGraphiteReporter
with the given properties, sending metrics using the givenGraphite
client.- Parameters:
graphite
- aGraphite
client- Returns:
- a
GraphiteReporter
-
-