org.apache.flink.metrics.statsd

Class StatsDReporter

java.lang.Object

org.apache.flink.metrics.reporter.AbstractReporter

org.apache.flink.metrics.statsd.StatsDReporter

All Implemented Interfaces:

CharacterFilter, MetricReporter, Scheduled

@PublicEvolving
public class StatsDReporter
extends AbstractReporter
implements Scheduled

Largely based on the StatsDReporter class by ReadyTalk.

https://github.com/ReadyTalk/metrics-statsd/blob/master/metrics3-statsd/src/main/java/com/readytalk/metrics/StatsDReporter.java

Ported since it was not present in maven central.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_HOST
static String	ARG_PORT

Fields inherited from class org.apache.flink.metrics.reporter.AbstractReporter

counters, gauges, histograms, log, meters

Fields inherited from interface org.apache.flink.metrics.CharacterFilter

NO_OP_FILTER

Constructor Summary

Constructors

Constructor and Description
StatsDReporter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reporter.
String	filterCharacters(String input) Filter the given string and generate a resulting string from it.
void	open(MetricConfig config) Configures this reporter.
void	report() Report the current measurements.

Methods inherited from class org.apache.flink.metrics.reporter.AbstractReporter

notifyOfAddedMetric, notifyOfRemovedMetric

Methods inherited from class java.lang.Object

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

Field Detail

ARG_HOST

public static final String ARG_HOST

See Also:

Constant Field Values

ARG_PORT

public static final String ARG_PORT

See Also:

Constant Field Values

Constructor Detail

StatsDReporter

public StatsDReporter()

Method Detail

open

public void open(MetricConfig config)

Description copied from interface: MetricReporter

Configures this reporter.

If the reporter was instantiated generically and hence parameter-less, this method is the place where the reporter sets it's basic fields based on configuration values. Otherwise, this method will typically be a no-op since resources can be acquired in the constructor.

This method is always called first on a newly instantiated reporter.

Specified by:

open in interface MetricReporter

Parameters:

config - A properties object that contains all parameters set for this reporter.

close

public void close()

Description copied from interface: MetricReporter

Closes this reporter. Should be used to close channels, streams and release resources.

Specified by:

close in interface MetricReporter

report

public void report()

Description copied from interface: Scheduled

Report the current measurements. This method is called periodically by the metrics registry that uses the reporter. This method must not block for a significant amount of time, any reporter needing more time should instead run the operation asynchronously.

Specified by:

report in interface Scheduled

filterCharacters

public String filterCharacters(String input)

Description copied from interface: CharacterFilter

Filter the given string and generate a resulting string from it.

For example, one implementation could filter out invalid characters from the input string.

Specified by:

filterCharacters in interface CharacterFilter

Parameters:

input - Input string

Returns:

Filtered result string