Class ExporterConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

io.confluent.telemetry.exporter.ExporterConfig

Direct Known Subclasses:

HttpExporterConfig, KafkaExporterConfig

public abstract class ExporterConfig
extends org.apache.kafka.common.config.AbstractConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExporterConfig.ExporterType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_NAME_CONFIG
static final String	CLIENT_NAME_CONFIG_DEFAULT
static final String	CLIENT_NAME_CONFIG_DOC
static final String	ENABLED_CONFIG
static final String	ENABLED_CONFIG_DOC
static final String	EVENTS_ENABLED_CONFIG
static final boolean	EVENTS_ENABLED_CONFIG_DEFAULT
static final String	EVENTS_ENABLED_CONFIG_DOC
static final String	METRICS_ENABLED_CONFIG
static final boolean	METRICS_ENABLED_CONFIG_DEFAULT
static final String	METRICS_ENABLED_CONFIG_DOC
static final String	METRICS_INCLUDE_CONFIG
static final String	METRICS_INCLUDE_CONFIG_DOC
static final String	NAMED_CLIENT_CONFIGURED_DOC_WARNING
static final Set<String>	RECONFIGURABLES
static final String	REMOTE_CONFIGURABLE_CONFIG
static final boolean	REMOTE_CONFIGURABLE_CONFIG_DEFAULT
static final String	REMOTE_CONFIGURABLE_CONFIG_DOC
static final String	TYPE_CONFIG
static final String	TYPE_CONFIG_DOC

Fields inherited from class org.apache.kafka.common.config.AbstractConfig

AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG, CONFIG_PROVIDERS_DOC

Constructor Summary

Constructors

Constructor	Description
ExporterConfig(String name, org.apache.kafka.common.config.ConfigDef definition, Map<?,?> originals, boolean doLog)

Method Summary

Modifier and Type	Method	Description
Optional<Predicate<Keyed>>	buildMetricsPredicate()	Gets the exporter specific predicated if the `metrics.include` is set.
String	getName()
ExporterConfig.ExporterType	getType()
boolean	isEnabled()
boolean	isMetricsEnabled()
boolean	isRemoteConfigurable()
static ExporterConfig.ExporterType	parseType(Object value)
ExporterConfig	reconfigure(Map<String,?> overrides, Map<String, ClientConfig> clientConfigMap)	Return a new ExporterConfig by overriding this config with the provided Map.

Methods inherited from class org.apache.kafka.common.config.AbstractConfig

documentationOf, equals, getBoolean, getClass, getConfiguredInstance, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, nonInternalValues, originals, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NAMED_CLIENT_CONFIGURED_DOC_WARNING

public static final String NAMED_CLIENT_CONFIGURED_DOC_WARNING

See Also:

• Constant Field Values

ENABLED_CONFIG

public static final String ENABLED_CONFIG

See Also:

• Constant Field Values

ENABLED_CONFIG_DOC

public static final String ENABLED_CONFIG_DOC

See Also:

• Constant Field Values

TYPE_CONFIG

public static final String TYPE_CONFIG

See Also:

• Constant Field Values

TYPE_CONFIG_DOC

public static final String TYPE_CONFIG_DOC

CLIENT_NAME_CONFIG

public static final String CLIENT_NAME_CONFIG

See Also:

• Constant Field Values

CLIENT_NAME_CONFIG_DOC

public static final String CLIENT_NAME_CONFIG_DOC

See Also:

• Constant Field Values

CLIENT_NAME_CONFIG_DEFAULT

public static final String CLIENT_NAME_CONFIG_DEFAULT

See Also:

• Constant Field Values

METRICS_INCLUDE_CONFIG

public static final String METRICS_INCLUDE_CONFIG

See Also:

• Constant Field Values

METRICS_INCLUDE_CONFIG_DOC

public static final String METRICS_INCLUDE_CONFIG_DOC

See Also:

• Constant Field Values

METRICS_ENABLED_CONFIG

public static final String METRICS_ENABLED_CONFIG

See Also:

• Constant Field Values

METRICS_ENABLED_CONFIG_DOC

public static final String METRICS_ENABLED_CONFIG_DOC

See Also:

• Constant Field Values

METRICS_ENABLED_CONFIG_DEFAULT

public static final boolean METRICS_ENABLED_CONFIG_DEFAULT

See Also:

• Constant Field Values

EVENTS_ENABLED_CONFIG

public static final String EVENTS_ENABLED_CONFIG

See Also:

• Constant Field Values

EVENTS_ENABLED_CONFIG_DOC

public static final String EVENTS_ENABLED_CONFIG_DOC

See Also:

• Constant Field Values

EVENTS_ENABLED_CONFIG_DEFAULT

public static final boolean EVENTS_ENABLED_CONFIG_DEFAULT

See Also:

• Constant Field Values

REMOTE_CONFIGURABLE_CONFIG

public static final String REMOTE_CONFIGURABLE_CONFIG

See Also:

• Constant Field Values

REMOTE_CONFIGURABLE_CONFIG_DOC

public static final String REMOTE_CONFIGURABLE_CONFIG_DOC

See Also:

• Constant Field Values

REMOTE_CONFIGURABLE_CONFIG_DEFAULT

public static final boolean REMOTE_CONFIGURABLE_CONFIG_DEFAULT

See Also:

• Constant Field Values

RECONFIGURABLES

public static final Set<String> RECONFIGURABLES

Constructor Details

ExporterConfig

public ExporterConfig(String name,
 org.apache.kafka.common.config.ConfigDef definition,
 Map<?,?> originals,
 boolean doLog)

Method Details

parseType

public static ExporterConfig.ExporterType parseType(Object value)

getName

public String getName()

getType

public ExporterConfig.ExporterType getType()

isEnabled

public boolean isEnabled()

isMetricsEnabled

public boolean isMetricsEnabled()

isRemoteConfigurable

public boolean isRemoteConfigurable()

reconfigure

public ExporterConfig reconfigure(Map<String,?> overrides,
 Map<String, ClientConfig> clientConfigMap)

Return a new ExporterConfig by overriding this config with the provided Map. Properties not present in overrides will be removed from the configuration.

buildMetricsPredicate

public Optional<Predicate<Keyed>> buildMetricsPredicate()

Gets the exporter specific predicated if the `metrics.include` is set. Otherwise, returns an empty Optional.