Status

Current state: "Accepted"

Discussion thread: here

JIRA: here []

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Some config's doc description is public in `StreamsConfig`, but it only used in the `StreamConfig` class or `TopologyConfig`. The overly large scope of these variables will increased the risk of misues.

We should deprecate the public ones to allow us making them private or package private in a future release.

One of variable is unused, so we also need to deprecate it.

Public Interfaces

• `org.apache.kafka.streams.StreamsConfig`

Proposed Changes

We proposed to deprecate some doc description variable, and make it from public to private or package private.

Compatibility, Deprecation, and Migration Plan

1. We will add a deprecated annotation on those used in `StreamsConfig` or `TopologyConfig` doc variables.

2. Make these variables to private at the next major release.

These variable will be modified, these used in `StreamsConfig` or `TopologyConfig`.

• `DEFAULT_CLIENT_SUPPLIER_DOC`
• `ENABLE_METRICS_PUSH_DOC`
• `PROCESSING_EXCEPTION_HANDLER_CLASS_DOC`
• `RACK_AWARE_ASSIGNMENT_NON_OVERLAP_COST_DOC`
• `RACK_AWARE_ASSIGNMENT_STRATEGY_DOC`
• `RACK_AWARE_ASSIGNMENT_TRAFFIC_COST_DOC`
• `BUFFERED_RECORDS_PER_PARTITION_DOC`
• `CACHE_MAX_BYTES_BUFFERING_DOC`
• `DEFAULT_DESERIALIZATION_EXCEPTION_HANDLER_CLASS_DOC`
• `DEFAULT_DSL_STORE_DOC`
• `DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_DOC`
• `MAX_TASK_IDLE_MS_DOC`
• `STATESTORE_CACHE_MAX_BYTES_DOC`
• `TASK_TIMEOUT_MS_DOC`

We also depreacte the unused variable

• `DUMMY_THREAD_INDEX`

Test Plan

n/a

Rejected Alternatives

n/a