Package org.apache.flink.configuration

Class EventOptions

java.lang.Object

org.apache.flink.configuration.EventOptions

@Experimental
public class EventOptions
extends Object

Configuration options for events and event reporters.

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigOption<Map<String,String>>	REPORTER_ADDITIONAL_VARIABLES
static ConfigOption<String>	REPORTER_CONFIG_PARAMETER
static ConfigOption<String>	REPORTER_EXCLUDED_VARIABLES
static ConfigOption<List<String>>	REPORTER_EXCLUDES
static ConfigOption<String>	REPORTER_FACTORY_CLASS
static ConfigOption<List<String>>	REPORTER_INCLUDES
static ConfigOption<String>	REPORTER_SCOPE_DELIMITER
static ConfigOption<String>	REPORTERS_LIST	An optional list of reporter names.

Method Summary

Modifier and Type	Method	Description
static Configuration	forEventReporter(Configuration configuration, String reporterName)	Returns a view over the given configuration via which options can be set/retrieved for the given reporter.
static Configuration	forReporter(Configuration configuration, String reporterName)

Methods inherited from class java.lang.Object

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

Field Detail

REPORTERS_LIST

public static final ConfigOption<String> REPORTERS_LIST

An optional list of reporter names. If configured, only reporters whose name matches any of the names in the list will be started. Otherwise, all reporters that could be found in the configuration will be started.

Example:

 events.reporters = foo,bar

 events.reporter.foo.class = org.apache.flink.events.reporter.OpenTelemetryEventReporter
 events.reporter.foo.endpoint = 127.0.0.1:4137
 

REPORTER_FACTORY_CLASS

public static final ConfigOption<String> REPORTER_FACTORY_CLASS

REPORTER_CONFIG_PARAMETER

public static final ConfigOption<String> REPORTER_CONFIG_PARAMETER

REPORTER_ADDITIONAL_VARIABLES

public static final ConfigOption<Map<String,String>> REPORTER_ADDITIONAL_VARIABLES

REPORTER_SCOPE_DELIMITER

public static final ConfigOption<String> REPORTER_SCOPE_DELIMITER

REPORTER_EXCLUDED_VARIABLES

public static final ConfigOption<String> REPORTER_EXCLUDED_VARIABLES

REPORTER_INCLUDES

public static final ConfigOption<List<String>> REPORTER_INCLUDES

REPORTER_EXCLUDES

public static final ConfigOption<List<String>> REPORTER_EXCLUDES

Method Detail

forReporter

@Experimental
public static Configuration forReporter(Configuration configuration,
                                        String reporterName)

forEventReporter

@Experimental
public static Configuration forEventReporter(Configuration configuration,
                                             String reporterName)

Returns a view over the given configuration via which options can be set/retrieved for the given reporter.

     Configuration config = ...
     MetricOptions.forReporter(config, "my_reporter")
         .set(MetricOptions.REPORTER_INTERVAL, Duration.ofSeconds(10))
         ...
 

Parameters:

configuration - backing configuration

reporterName - reporter name

Returns:

view over configuration