This is an automated email from the ASF dual-hosted git repository.
mjsax pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new 4121a8952a3 KAFKA-17427: Deprecate leaking *_DOC variables in
StreamsConfig (#17171)
4121a8952a3 is described below
commit 4121a8952a3e7fb27d6eb377ab3a61e0c45c3445
Author: Ken Huang <[email protected]>
AuthorDate: Fri Sep 13 01:26:00 2024 +0800
KAFKA-17427: Deprecate leaking *_DOC variables in StreamsConfig (#17171)
Reviewers: Matthias J. Sax <[email protected]>
---
.../main/java/org/apache/kafka/streams/StreamsConfig.java | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
index 0288d9bdfec..de83199a6f3 100644
--- a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
+++ b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
@@ -160,6 +160,7 @@ public class StreamsConfig extends AbstractConfig {
private static final long EOS_DEFAULT_COMMIT_INTERVAL_MS = 100L;
private static final int DEFAULT_TRANSACTION_TIMEOUT = 10000;
+ @Deprecated
@SuppressWarnings("unused")
public static final int DUMMY_THREAD_INDEX = 1;
public static final long MAX_TASK_IDLE_MS_DISABLED = -1;
@@ -494,6 +495,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code buffered.records.per.partition} */
@SuppressWarnings("WeakerAccess")
public static final String BUFFERED_RECORDS_PER_PARTITION_CONFIG =
"buffered.records.per.partition";
+ @Deprecated
public static final String BUFFERED_RECORDS_PER_PARTITION_DOC = "Maximum
number of records to buffer per partition.";
/** {@code built.in.metrics.version} */
@@ -505,6 +507,7 @@ public class StreamsConfig extends AbstractConfig {
@SuppressWarnings("WeakerAccess")
@Deprecated
public static final String CACHE_MAX_BYTES_BUFFERING_CONFIG =
"cache.max.bytes.buffering";
+ @Deprecated
public static final String CACHE_MAX_BYTES_BUFFERING_DOC = "Maximum number
of memory bytes to be used for buffering across all threads";
/** {@code client.id} */
@@ -529,6 +532,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code default.client.supplier} */
@SuppressWarnings("WeakerAccess")
public static final String DEFAULT_CLIENT_SUPPLIER_CONFIG =
"default.client.supplier";
+ @Deprecated
public static final String DEFAULT_CLIENT_SUPPLIER_DOC = "Client supplier
class that implements the
<code>org.apache.kafka.streams.KafkaClientSupplier</code> interface.";
/**
@@ -591,11 +595,13 @@ public class StreamsConfig extends AbstractConfig {
/** {@code default.timestamp.extractor} */
@SuppressWarnings("WeakerAccess")
public static final String DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_CONFIG =
"default.timestamp.extractor";
+ @Deprecated
public static final String DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_DOC =
"Default timestamp extractor class that implements the
<code>org.apache.kafka.streams.processor.TimestampExtractor</code> interface.";
/** {@code enable.metrics.push} */
@SuppressWarnings("WeakerAccess")
public static final String ENABLE_METRICS_PUSH_CONFIG =
CommonClientConfigs.ENABLE_METRICS_PUSH_CONFIG;
+ @Deprecated
public static final String ENABLE_METRICS_PUSH_DOC = "Whether to enable
pushing of internal client metrics for (main, restore, and global) consumers,
producers, and admin clients." +
" The cluster must have a client metrics subscription which
corresponds to a client.";
@@ -607,6 +613,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code max.task.idle.ms} */
public static final String MAX_TASK_IDLE_MS_CONFIG = "max.task.idle.ms";
+ @Deprecated
public static final String MAX_TASK_IDLE_MS_DOC = "This config controls
whether joins and merges"
+ " may produce out-of-order results."
+ " The config value is the maximum amount of time in milliseconds a
stream task will stay idle"
@@ -678,6 +685,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code processing.exception.handler} */
@SuppressWarnings("WeakerAccess")
public static final String PROCESSING_EXCEPTION_HANDLER_CLASS_CONFIG =
"processing.exception.handler";
+ @Deprecated
public static final String PROCESSING_EXCEPTION_HANDLER_CLASS_DOC =
"Exception handling class that implements the
<code>org.apache.kafka.streams.errors.ProcessingExceptionHandler</code>
interface.";
/** {@code processing.guarantee} */
@@ -706,6 +714,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code rack.aware.assignment.non_overlap_cost} */
@SuppressWarnings("WeakerAccess")
public static final String RACK_AWARE_ASSIGNMENT_NON_OVERLAP_COST_CONFIG =
"rack.aware.assignment.non_overlap_cost";
+ @Deprecated
public static final String RACK_AWARE_ASSIGNMENT_NON_OVERLAP_COST_DOC =
"Cost associated with moving tasks from existing assignment. This config and
<code>rack.aware.assignment.traffic_cost</code> controls whether the "
+ "optimization algorithm favors minimizing cross rack traffic or
minimize the movement of tasks in existing assignment. If set a larger value
<code>" + RackAwareTaskAssignor.class.getName() + "</code> will "
+ "optimize to maintain the existing assignment. The default value is
null which means it will use default non_overlap cost values in different
assignors.";
@@ -713,6 +722,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code rack.aware.assignment.strategy} */
@SuppressWarnings("WeakerAccess")
public static final String RACK_AWARE_ASSIGNMENT_STRATEGY_CONFIG =
"rack.aware.assignment.strategy";
+ @Deprecated
public static final String RACK_AWARE_ASSIGNMENT_STRATEGY_DOC = "The
strategy we use for rack aware assignment. Rack aware assignment will take
<code>client.rack</code> and <code>racks</code> of <code>TopicPartition</code>
into account when assigning"
+ " tasks to minimize cross rack traffic. Valid settings are : <code>"
+ RACK_AWARE_ASSIGNMENT_STRATEGY_NONE + "</code> (default), which will disable
rack aware assignment; <code>" + RACK_AWARE_ASSIGNMENT_STRATEGY_MIN_TRAFFIC
+ "</code>, which will compute minimum cross rack traffic assignment;
<code>" + RACK_AWARE_ASSIGNMENT_STRATEGY_BALANCE_SUBTOPOLOGY + "</code>, which
will compute minimum cross rack traffic and try to balance the tasks of same
subtopolgies across different clients";
@@ -727,6 +737,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code rack.aware.assignment.traffic_cost} */
@SuppressWarnings("WeakerAccess")
public static final String RACK_AWARE_ASSIGNMENT_TRAFFIC_COST_CONFIG =
"rack.aware.assignment.traffic_cost";
+ @Deprecated
public static final String RACK_AWARE_ASSIGNMENT_TRAFFIC_COST_DOC = "Cost
associated with cross rack traffic. This config and
<code>rack.aware.assignment.non_overlap_cost</code> controls whether the "
+ "optimization algorithm favors minimizing cross rack traffic or
minimize the movement of tasks in existing assignment. If set a larger value
<code>" + RackAwareTaskAssignor.class.getName() + "</code> will "
+ "optimize for minimizing cross rack traffic. The default value is
null which means it will use default traffic cost values in different
assignors.";
@@ -779,6 +790,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code statestore.cache.max.bytes} */
@SuppressWarnings("WeakerAccess")
public static final String STATESTORE_CACHE_MAX_BYTES_CONFIG =
"statestore.cache.max.bytes";
+ @Deprecated
public static final String STATESTORE_CACHE_MAX_BYTES_DOC = "Maximum
number of memory bytes to be used for statestore cache across all threads";
/** {@code task.assignor.class} */
@@ -789,6 +801,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code task.timeout.ms} */
public static final String TASK_TIMEOUT_MS_CONFIG = "task.timeout.ms";
+ @Deprecated
public static final String TASK_TIMEOUT_MS_DOC = "The maximum amount of
time in milliseconds a task might stall due to internal errors and retries
until an error is raised. " +
"For a timeout of 0ms, a task would raise an error for the first
internal error. " +
"For any timeout larger than 0ms, a task will retry at least once
before an error is raised.";
