com.wavefront.dropwizard.metrics

Class DropwizardMetricsReporter.Builder

java.lang.Object

com.wavefront.dropwizard.metrics.DropwizardMetricsReporter.Builder

Enclosing class:

DropwizardMetricsReporter

public static class DropwizardMetricsReporter.Builder
extends Object

A builder for DropwizardMetricsReporter instances. Defaults to not using a prefix, using the default clock, converting rates to events/second, converting durations to milliseconds, a host named "dropwizard-metrics", no point Tags, and not filtering any metrics.

Method Summary

Modifier and Type	Method and Description
DropwizardMetricsReporter	build(com.wavefront.sdk.common.WavefrontSender wavefrontSender) Builds a DropwizardMetricsReporter with the given properties, sending metrics and histograms directly to a given Wavefront server using either proxy or direct ingestion APIs.
DropwizardMetricsReporter.Builder	disabledMetricAttributes(Set<com.codahale.metrics.MetricAttribute> disabledMetricAttributes) Don't report the passed metric attributes for all metrics (e.g.
DropwizardMetricsReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
DropwizardMetricsReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
DropwizardMetricsReporter.Builder	reportDayDistribution() Report histogram distributions aggregated into day intervals
DropwizardMetricsReporter.Builder	reportHourDistribution() Report histogram distributions aggregated into hour intervals
DropwizardMetricsReporter.Builder	reportMinuteDistribution() Report histogram distributions aggregated into minute intervals
DropwizardMetricsReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.
DropwizardMetricsReporter.Builder	withJvmMetrics() Include JVM Metrics from this Reporter.
DropwizardMetricsReporter.Builder	withReporterPointTag(String tagKey, String tagVal) Set a point tag for this reporter.
DropwizardMetricsReporter.Builder	withReporterPointTags(Map<String,String> reporterPointTags) Set the Point Tags for this reporter.
DropwizardMetricsReporter.Builder	withSource(String source) Set the source for this reporter.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

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

Use the given Clock instance for the time. Defaults to Clock.defaultClock()

Parameters:

clock - a Clock instance

Returns:

this

prefixedWith

public DropwizardMetricsReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string. Defaults to null.

Parameters:

prefix - the prefix for all metric names

Returns:

this

withSource

public DropwizardMetricsReporter.Builder withSource(String source)

Set the source for this reporter. This is equivalent to withHost.

Parameters:

source - the host for all metrics

Returns:

this

withReporterPointTags

public DropwizardMetricsReporter.Builder withReporterPointTags(Map<String,String> reporterPointTags)

Set the Point Tags for this reporter.

Parameters:

reporterPointTags - the pointTags Map for all metrics

Returns:

this

withReporterPointTag

public DropwizardMetricsReporter.Builder withReporterPointTag(String tagKey,
                                                              String tagVal)

Set a point tag for this reporter.

Parameters:

tagKey - the key of the Point Tag

tagVal - the value of the Point Tag

Returns:

this

filter

public DropwizardMetricsReporter.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

disabledMetricAttributes

public DropwizardMetricsReporter.Builder disabledMetricAttributes(Set<com.codahale.metrics.MetricAttribute> disabledMetricAttributes)

Don't report the passed metric attributes for all metrics (e.g. "p999", "stddev" or "m15"). See MetricAttribute.

Parameters:

disabledMetricAttributes - a set of MetricAttribute

Returns:

this

withJvmMetrics

public DropwizardMetricsReporter.Builder withJvmMetrics()

Include JVM Metrics from this Reporter.

Returns:

this

reportMinuteDistribution

public DropwizardMetricsReporter.Builder reportMinuteDistribution()

Report histogram distributions aggregated into minute intervals

Returns:

this

reportHourDistribution

public DropwizardMetricsReporter.Builder reportHourDistribution()

Report histogram distributions aggregated into hour intervals

Returns:

this

reportDayDistribution

public DropwizardMetricsReporter.Builder reportDayDistribution()

Report histogram distributions aggregated into day intervals

Returns:

this

build

public DropwizardMetricsReporter build(com.wavefront.sdk.common.WavefrontSender wavefrontSender)

Builds a DropwizardMetricsReporter with the given properties, sending metrics and histograms directly to a given Wavefront server using either proxy or direct ingestion APIs.

Parameters:

wavefrontSender - Wavefront Sender to send various Wavefront atoms.

Returns:

a DropwizardMetricsReporter