org.apache.flink.dropwizard

Class ScheduledDropwizardReporter

java.lang.Object

org.apache.flink.dropwizard.ScheduledDropwizardReporter

All Implemented Interfaces:

com.codahale.metrics.Reporter, CharacterFilter, MetricReporter, Scheduled

Direct Known Subclasses:

GraphiteReporter

@PublicEvolving
public abstract class ScheduledDropwizardReporter
extends Object
implements MetricReporter, Scheduled, com.codahale.metrics.Reporter, CharacterFilter

Base class for MetricReporter that wraps a Dropwizard Reporter.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_CONVERSION_DURATION
static String	ARG_CONVERSION_RATE
static String	ARG_HOST
static String	ARG_PORT
static String	ARG_PREFIX
protected org.slf4j.Logger	log
protected com.codahale.metrics.MetricRegistry	registry
protected com.codahale.metrics.ScheduledReporter	reporter

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

NO_OP_FILTER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScheduledDropwizardReporter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this reporter.
String	filterCharacters(String metricName) Filter the given string and generate a resulting string from it.
abstract com.codahale.metrics.ScheduledReporter	getReporter(MetricConfig config)
void	notifyOfAddedMetric(Metric metric, String metricName, MetricGroup group) Called when a new Metric was added.
void	notifyOfRemovedMetric(Metric metric, String metricName, MetricGroup group) Called when a Metric was removed.
void	open(MetricConfig config) Configures this reporter.
void	report() Report the current measurements.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

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

ARG_PREFIX

public static final String ARG_PREFIX

See Also:

Constant Field Values

ARG_CONVERSION_RATE

public static final String ARG_CONVERSION_RATE

See Also:

Constant Field Values

ARG_CONVERSION_DURATION

public static final String ARG_CONVERSION_DURATION

See Also:

Constant Field Values

registry

protected final com.codahale.metrics.MetricRegistry registry

reporter

protected com.codahale.metrics.ScheduledReporter reporter

Constructor Detail

ScheduledDropwizardReporter

protected ScheduledDropwizardReporter()

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

notifyOfAddedMetric

public void notifyOfAddedMetric(Metric metric,
                                String metricName,
                                MetricGroup group)

Description copied from interface: MetricReporter

Called when a new Metric was added.

Specified by:

notifyOfAddedMetric in interface MetricReporter

Parameters:

metric - the metric that was added

metricName - the name of the metric

group - the group that contains the metric

notifyOfRemovedMetric

public void notifyOfRemovedMetric(Metric metric,
                                  String metricName,
                                  MetricGroup group)

Description copied from interface: MetricReporter

Called when a Metric was removed.

Specified by:

notifyOfRemovedMetric in interface MetricReporter

Parameters:

metric - the metric that should be removed

metricName - the name of the metric

group - the group that contains the metric

filterCharacters

public String filterCharacters(String metricName)

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:

metricName - Input string

Returns:

Filtered result string

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

getReporter

public abstract com.codahale.metrics.ScheduledReporter getReporter(MetricConfig config)