com.wavefront.integrations.metrics

Class WavefrontYammerMetricsReporter

java.lang.Object

com.yammer.metrics.reporting.AbstractReporter

com.wavefront.integrations.metrics.WavefrontYammerMetricsReporter

All Implemented Interfaces:

Runnable

public class WavefrontYammerMetricsReporter
extends com.yammer.metrics.reporting.AbstractReporter
implements Runnable

Author:

Mori Bellamy (mori@wavefront.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	logger

Constructor Summary

Constructors

Constructor and Description
WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry, String name, String hostname, int port, int wavefrontHistogramPort, java.util.function.Supplier<Long> timeSupplier)
WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry, String name, String hostname, int port, int wavefrontHistogramPort, java.util.function.Supplier<Long> timeSupplier, boolean prependGroupName, MetricTranslator metricTranslator, boolean includeJvmMetrics, boolean clearMetrics)
WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry, String name, String hostname, int port, int wavefrontHistogramPort, java.util.function.Supplier<Long> timeSupplier, boolean prependGroupName, MetricTranslator metricTranslator, boolean includeJvmMetrics, boolean clearMetrics, boolean sendZeroCounters, boolean sendEmptyHistograms) Reporter of a Yammer metrics registry to Wavefront.
WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry, String name, String hostname, int port, int wavefrontHistogramPort, java.util.function.Supplier<Long> timeSupplier, boolean prependGroupName, MetricTranslator metricTranslator, boolean includeJvmMetrics, boolean clearMetrics, boolean sendZeroCounters, boolean sendEmptyHistograms, Long connectionTimeToLiveMillis) Reporter of a Yammer metrics registry to Wavefront.

Method Summary

Modifier and Type	Method and Description
void	run()
void	shutdown()
void	shutdown(long timeout, TimeUnit unit) Shuts down the reporter polling, waiting the specific amount of time for any current polls to complete.
void	start(long initialDelay, long period, TimeUnit unit) Starts the reporter polling at the given period with specified initial delay
void	start(long period, TimeUnit unit) Starts the reporter polling at the given period.

Methods inherited from class com.yammer.metrics.reporting.AbstractReporter

getMetricsRegistry

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

Constructor Detail

WavefrontYammerMetricsReporter

public WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry,
                                      String name,
                                      String hostname,
                                      int port,
                                      int wavefrontHistogramPort,
                                      java.util.function.Supplier<Long> timeSupplier)
                               throws IOException

Throws:

IOException

WavefrontYammerMetricsReporter

public WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry,
                                      String name,
                                      String hostname,
                                      int port,
                                      int wavefrontHistogramPort,
                                      java.util.function.Supplier<Long> timeSupplier,
                                      boolean prependGroupName,
                                      @Nullable
                                      MetricTranslator metricTranslator,
                                      boolean includeJvmMetrics,
                                      boolean clearMetrics)
                               throws IOException

Throws:

IOException

WavefrontYammerMetricsReporter

public WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry,
                                      String name,
                                      String hostname,
                                      int port,
                                      int wavefrontHistogramPort,
                                      java.util.function.Supplier<Long> timeSupplier,
                                      boolean prependGroupName,
                                      @Nullable
                                      MetricTranslator metricTranslator,
                                      boolean includeJvmMetrics,
                                      boolean clearMetrics,
                                      boolean sendZeroCounters,
                                      boolean sendEmptyHistograms)
                               throws IOException

Reporter of a Yammer metrics registry to Wavefront.

Parameters:

metricsRegistry - The registry to scan-and-report

name - A human readable name for this reporter

hostname - The remote host where the wavefront proxy resides

port - Listening port on Wavefront proxy of graphite-like telemetry data

wavefrontHistogramPort - Listening port for Wavefront histogram data

timeSupplier - Get current timestamp, stubbed for testing

prependGroupName - If true, outgoing telemetry is of the form "group.name" rather than "name".

metricTranslator - If present, applied to each MetricName/Metric pair before flushing to Wavefront. This is useful for adding point tags. Warning: this is called once per metric per scan, so it should probably be performant. May be null.

clearMetrics - If true, clear histograms and timers per flush.

sendZeroCounters - Whether counters with a value of zero is sent across.

sendEmptyHistograms - Whether empty histograms are sent across the wire.

includeJvmMetrics - Whether JVM metrics are automatically included.

Throws:

IOException - When we can't remotely connect to Wavefront.

WavefrontYammerMetricsReporter

public WavefrontYammerMetricsReporter(MetricsRegistry metricsRegistry,
                                      String name,
                                      String hostname,
                                      int port,
                                      int wavefrontHistogramPort,
                                      java.util.function.Supplier<Long> timeSupplier,
                                      boolean prependGroupName,
                                      @Nullable
                                      MetricTranslator metricTranslator,
                                      boolean includeJvmMetrics,
                                      boolean clearMetrics,
                                      boolean sendZeroCounters,
                                      boolean sendEmptyHistograms,
                                      @Nullable
                                      Long connectionTimeToLiveMillis)
                               throws IOException

Reporter of a Yammer metrics registry to Wavefront.

Parameters:

metricsRegistry - The registry to scan-and-report

name - A human readable name for this reporter

hostname - The remote host where the wavefront proxy resides

port - Listening port on Wavefront proxy of graphite-like telemetry data

wavefrontHistogramPort - Listening port for Wavefront histogram data

timeSupplier - Get current timestamp, stubbed for testing

prependGroupName - If true, outgoing telemetry is of the form "group.name" rather than "name".

metricTranslator - If present, applied to each MetricName/Metric pair before flushing to Wavefront. This is useful for adding point tags. Warning: this is called once per metric per scan, so it should probably be performant. May be null.

clearMetrics - If true, clear histograms and timers per flush.

sendZeroCounters - Whether counters with a value of zero is sent across.

sendEmptyHistograms - Whether empty histograms are sent across the wire.

includeJvmMetrics - Whether JVM metrics are automatically included.

connectionTimeToLiveMillis - Connection TTL, with expiration checked after each flush. When null, TTL is not enforced.

Throws:

IOException - When we can't remotely connect to Wavefront.

Method Detail

start

public void start(long period,
                  TimeUnit unit)

Starts the reporter polling at the given period.

Parameters:

period - the amount of time between polls

unit - the unit for period

start

public void start(long initialDelay,
                  long period,
                  TimeUnit unit)

Starts the reporter polling at the given period with specified initial delay

Parameters:

initialDelay - the amount of time before first execution

period - the amount of time between polls

unit - the unit for initialDelay and period

shutdown

public void shutdown(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Shuts down the reporter polling, waiting the specific amount of time for any current polls to complete.

Parameters:

timeout - the maximum time to wait

unit - the unit for timeout

Throws:

InterruptedException - if interrupted while waiting

shutdown

public void shutdown()

Overrides:

shutdown in class com.yammer.metrics.reporting.AbstractReporter

run

public void run()

Specified by:

run in interface Runnable