Package org.apache.flink.runtime.metrics

Class ReporterSetup

java.lang.Object

org.apache.flink.runtime.metrics.ReporterSetup

public final class ReporterSetup
extends Object

Encapsulates everything needed for the instantiation and configuration of a MetricReporter.

Constructor Summary

Constructors

Constructor	Description
ReporterSetup(String name, org.apache.flink.metrics.MetricConfig configuration, org.apache.flink.metrics.reporter.MetricReporter reporter, MetricFilter filter, Map<String,String> additionalVariables)

Method Summary

Modifier and Type	Method	Description
static Set<String>	findEnabledTraceReportersInConfiguration(org.apache.flink.configuration.Configuration configuration, String includedReportersString, Pattern reporterListPattern, Pattern reporterClassPattern, String reporterPrefix)
static ReporterSetup	forReporter(String reporterName, org.apache.flink.metrics.MetricConfig metricConfig, org.apache.flink.metrics.reporter.MetricReporter reporter)
static ReporterSetup	forReporter(String reporterName, org.apache.flink.metrics.reporter.MetricReporter reporter)
static ReporterSetup	forReporter(String reporterName, MetricFilter metricFilter, org.apache.flink.metrics.reporter.MetricReporter reporter)
static List<ReporterSetup>	fromConfiguration(org.apache.flink.configuration.Configuration configuration, org.apache.flink.core.plugin.PluginManager pluginManager)
Map<String,String>	getAdditionalVariables()
Optional<String>	getDelimiter()
Set<String>	getExcludedVariables()
MetricFilter	getFilter()
Optional<String>	getIntervalSettings()
String	getName()
org.apache.flink.metrics.reporter.MetricReporter	getReporter()
static List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.configuration.Configuration>>	loadReporterConfigurations(org.apache.flink.configuration.Configuration configuration, Set<String> namedReporters, String reporterPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReporterSetup

public ReporterSetup(String name,
                     org.apache.flink.metrics.MetricConfig configuration,
                     org.apache.flink.metrics.reporter.MetricReporter reporter,
                     MetricFilter filter,
                     Map<String,String> additionalVariables)

Method Detail

getDelimiter

public Optional<String> getDelimiter()

getIntervalSettings

public Optional<String> getIntervalSettings()

getExcludedVariables

public Set<String> getExcludedVariables()

getFilter

public MetricFilter getFilter()

getAdditionalVariables

public Map<String,String> getAdditionalVariables()

getName

public String getName()

getReporter

public org.apache.flink.metrics.reporter.MetricReporter getReporter()

forReporter

@VisibleForTesting
public static ReporterSetup forReporter(String reporterName,
                                        org.apache.flink.metrics.reporter.MetricReporter reporter)

forReporter

@VisibleForTesting
public static ReporterSetup forReporter(String reporterName,
                                        org.apache.flink.metrics.MetricConfig metricConfig,
                                        org.apache.flink.metrics.reporter.MetricReporter reporter)

forReporter

@VisibleForTesting
public static ReporterSetup forReporter(String reporterName,
                                        MetricFilter metricFilter,
                                        org.apache.flink.metrics.reporter.MetricReporter reporter)

fromConfiguration

public static List<ReporterSetup> fromConfiguration(org.apache.flink.configuration.Configuration configuration,
                                                    @Nullable
                                                    org.apache.flink.core.plugin.PluginManager pluginManager)

findEnabledTraceReportersInConfiguration

public static Set<String> findEnabledTraceReportersInConfiguration(org.apache.flink.configuration.Configuration configuration,
                                                                   String includedReportersString,
                                                                   Pattern reporterListPattern,
                                                                   Pattern reporterClassPattern,
                                                                   String reporterPrefix)

loadReporterConfigurations

public static List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.configuration.Configuration>> loadReporterConfigurations(org.apache.flink.configuration.Configuration configuration,
                                                                                                                                                 Set<String> namedReporters,
                                                                                                                                                 String reporterPrefix)