kafka icon indicating copy to clipboard operation
kafka copied to clipboard

KAFKA-15307: update/note deprecated configs

Open Cerchie opened this issue 2 years ago • 5 comments

First pass at identifying deprecated configs listed in https://kafka.apache.org/21/documentation/streams/developer-guide/config-streams

There might be some discussion to be had regarding what to say about why these are deprecated.

Also, in the StreamsConfig.java line 1355, some logic throws errors when EXACTLY_ONCE, EXACTLY_ONCE_BETA, and RETRIES are used. Should that be updated as well, considering that there are new pieces of config with the @Deprecated annotation?

Committer Checklist (excluded from commit message)

  • [ ] Verify design and implementation
  • [ ] Verify test coverage and CI build status
  • [ ] Verify documentation (including upgrade notes)

Cerchie avatar Sep 08 '23 18:09 Cerchie

There might be some discussion to be had regarding what to say about why these are deprecated.

Not sure if we need to put this into the docs? If we want to say something about it, we could add a link to the corresponding KIP, ie, "Deprecated via KIP-xxx" -- the KIP will contain the necessary information.

What we should do in any case is, link to configs that should be used instead of the deprecated ones (seems we cannot do this in this PR though, as some new config are still missing in the doc -- or we add them in this PR directly)

Also, in the StreamsConfig.java line 1355, some logic throws errors when EXACTLY_ONCE, EXACTLY_ONCE_BETA, and RETRIES are used. Should that be updated as well, considering that there are new pieces of config with the @Deprecated annotation?

Yes, very good idea to extend this code and also log an error if other deprecated configs are used.

mjsax avatar Sep 12 '23 01:09 mjsax

There might be some discussion to be had regarding what to say about why these are deprecated.

Not sure if we need to put this into the docs? If we want to say something about it, we could add a link to the corresponding KIP, ie, "Deprecated via KIP-xxx" -- the KIP will contain the necessary information.

What we should do in any case is, link to configs that should be used instead of the deprecated ones (seems we cannot do this in this PR though, as some new config are still missing in the doc -- or we add them in this PR directly)

Also, in the StreamsConfig.java line 1355, some logic throws errors when EXACTLY_ONCE, EXACTLY_ONCE_BETA, and RETRIES are used. Should that be updated as well, considering that there are new pieces of config with the @deprecated annotation?

Yes, very good idea to extend this code and also log an error if other deprecated configs are used.

happy to add those new config in this PR -- shall I also add that StreamsConfig.java logic update in this PR, or separate it out since it's a code update rather than a docs one?

Cerchie avatar Sep 12 '23 20:09 Cerchie

happy to add those new config in this PR

Great.

shall I also add that StreamsConfig.java logic update in this PR, or separate it out since it's a code update rather than a docs one?

Guess both ways work, but I tend to think splitting out a new PR might be better.

mjsax avatar Sep 13 '23 16:09 mjsax

happy to add those new config in this PR

Great.

shall I also add that StreamsConfig.java logic update in this PR, or separate it out since it's a code update rather than a docs one?

Guess both ways work, but I tend to think splitting out a new PR might be better.

Here's the new PR: https://github.com/apache/kafka/pull/14448

Cerchie avatar Sep 25 '23 19:09 Cerchie

This PR is being marked as stale since it has not had any activity in 90 days. If you would like to keep this PR alive, please ask a committer for review. If the PR has merge conflicts, please update it with the latest from trunk (or appropriate release branch)

If this PR is no longer valid or desired, please feel free to close it. If no activity occurs in the next 30 days, it will be automatically closed.

github-actions[bot] avatar Dec 25 '23 03:12 github-actions[bot]

tagging @mjsax here, made some edits in response to the last roung

Cerchie avatar Apr 30 '24 20:04 Cerchie

Thanks for the PR @Cerchie! Merged to trunk.

mjsax avatar May 10 '24 02:05 mjsax

Hi @mjsax @Cerchie FYI this causes some javadoc build issues:

streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:661: warning - Tag @link: reference not found: JMX_REPORTER"jmx.reporter"
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:575: warning - invalid usage of tag {@code default.windowed.key.serde.inner
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:583: warning - invalid usage of tag {@code default.windowed.value.serde.inner
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:661: warning - Tag @link: reference not found: JMX_REPORTER"jmx.reporter"
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:660: warning - invalid usage of tag {@code auto.include.jmx.reporter
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:661: warning - Tag @link: reference not found: JMX_REPORTER"jmx.reporter"
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:661: warning - Tag @link: reference not found: JMX_REPORTER"jmx.reporter"

gharris1727 avatar May 13 '24 17:05 gharris1727

Thanks @gharris1727

@Cerchie -- can you add fixes into #14448 ?

mjsax avatar May 16 '24 06:05 mjsax