org.apache.flink.configuration

Class TraceOptions

java.lang.Object

org.apache.flink.configuration.TraceOptions

@Experimental
public class TraceOptions
extends Object

Configuration options for traces and trace reporters.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<Boolean>	REPORT_EVENTS_AS_SPANS Deprecated.
static ConfigOption<Map<String,String>>	REPORTER_ADDITIONAL_VARIABLES
static ConfigOption<String>	REPORTER_CONFIG_PARAMETER
static ConfigOption<String>	REPORTER_FACTORY_CLASS
static ConfigOption<String>	TRACE_REPORTERS_LIST An optional list of reporter names.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

TRACE_REPORTERS_LIST

public static final ConfigOption<String> TRACE_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:

 traces.reporters = foo,bar

 traces.reporter.foo.class = org.apache.flink.traces.reporter.OpenTelemetryTraceReporter
 traces.reporter.foo.endpoint = 127.0.0.1:4137
 

REPORT_EVENTS_AS_SPANS

@Deprecated
public static final ConfigOption<Boolean> REPORT_EVENTS_AS_SPANS

Deprecated.

Temporary option to report events as span. This option will be removed once we support reporting events.

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

Method Detail

forTraceReporter

@Experimental
public static Configuration forTraceReporter(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