Package com.arpnetworking.tsdcore.sinks

Class PeriodFilteringSink

java.lang.Object

com.arpnetworking.tsdcore.sinks.BaseSink

com.arpnetworking.tsdcore.sinks.PeriodFilteringSink

All Implemented Interfaces:

Sink

public final class PeriodFilteringSink
extends BaseSink

A publisher that wraps another, filters the metrics with specific periods, and forwards included metrics to the wrapped sink. This class is thread safe.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot io)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PeriodFilteringSink.Builder	Base PeriodFilteringSink.Builder implementation.

Method Summary

Modifier and Type	Method	Description
void	close()	Called to allow the publisher to clean-up.
void	recordAggregateData(PeriodicData periodicData)	Called when an additional PeriodicData instance is available for publication.
Object	toLogValue()	Generate a Steno log compatible representation.

Methods inherited from class com.arpnetworking.tsdcore.sinks.BaseSink

getMetricSafeName, getName, toString

Methods inherited from class java.lang.Object

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

Method Details

recordAggregateData

public void recordAggregateData(PeriodicData periodicData)

Description copied from interface: Sink

Called when an additional PeriodicData instance is available for publication.

Parameters:

periodicData - The PeriodicData to be published.

close

public void close()

Description copied from interface: Sink

Called to allow the publisher to clean-up. No further calls to recordAggregation will be made after a call to close.

toLogValue

public Object toLogValue()

Description copied from class: BaseSink

Generate a Steno log compatible representation.

Overrides:

toLogValue in class BaseSink

Returns:

Steno log compatible representation.