com.github.joshelser.dropwizard.metrics.hadoop

Class HadoopMetrics2Reporter.Builder

java.lang.Object

com.github.joshelser.dropwizard.metrics.hadoop.HadoopMetrics2Reporter.Builder

Enclosing class:

HadoopMetrics2Reporter

public static class HadoopMetrics2Reporter.Builder
extends Object

A builder to create HadoopMetrics2Reporter instances.

Method Summary

Methods

Modifier and Type	Method and Description
HadoopMetrics2Reporter	build(org.apache.hadoop.metrics2.MetricsSystem metrics2System, String jmxContext, String description, String recordName) Builds a HadoopMetrics2Reporter with the given properties, making metrics available to the Hadoop Metrics2 framework (any configured MetricsSources.
HadoopMetrics2Reporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
HadoopMetrics2Reporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
HadoopMetrics2Reporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
HadoopMetrics2Reporter.Builder	recordContext(String recordContext) A "context" name that will be added as a tag on each emitted metric record.

Methods inherited from class java.lang.Object

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

Method Detail

convertRatesTo

public HadoopMetrics2Reporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit. Defaults to TimeUnit.SECONDS.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public HadoopMetrics2Reporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit. Defaults to TimeUnit.MILLISECONDS.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

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

Only report metrics which match the given filter. Defaults to MetricFilter.ALL.

Parameters:

filter - a MetricFilter

Returns:

this

recordContext

public HadoopMetrics2Reporter.Builder recordContext(String recordContext)

A "context" name that will be added as a tag on each emitted metric record. Defaults to no "context" attribute on each record.

Parameters:

recordContext - The "context" tag

Returns:

this

build

public HadoopMetrics2Reporter build(org.apache.hadoop.metrics2.MetricsSystem metrics2System,
                           String jmxContext,
                           String description,
                           String recordName)

Builds a HadoopMetrics2Reporter with the given properties, making metrics available to the Hadoop Metrics2 framework (any configured MetricsSources.

Parameters:

metrics2System - The Hadoop Metrics2 system instance.

jmxContext - The JMX "path", e.g. "MyServer,sub=Requests".

description - A description these metrics.

recordName - A suffix included on each record to identify it.

Returns:

a HadoopMetrics2Reporter