org.opennms.newts.reporter.metrics

Class NewtsReporter.Builder

java.lang.Object

org.opennms.newts.reporter.metrics.NewtsReporter.Builder

Enclosing class:

NewtsReporter

public static class NewtsReporter.Builder
extends Object

A builder for NewtsReporter instances. Defaults to using the default locale, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Methods

Modifier and Type	Method and Description
NewtsReporter	build(org.opennms.newts.api.SampleRepository repository) Builds a NewtsReporter with the given properties, writing .csv files to the given directory.
NewtsReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
NewtsReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
NewtsReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
NewtsReporter.Builder	name(String name)
NewtsReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.

Methods inherited from class java.lang.Object

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

Method Detail

convertRatesTo

public NewtsReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public NewtsReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

withClock

public NewtsReporter.Builder withClock(com.codahale.metrics.Clock clock)

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

filter

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

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

name

public NewtsReporter.Builder name(String name)

build

public NewtsReporter build(org.opennms.newts.api.SampleRepository repository)

Builds a NewtsReporter with the given properties, writing .csv files to the given directory.

Parameters:

directory - the directory in which the .csv files will be created

Returns:

a NewtsReporter