Skip to content

KAFKA-20110 Fix generated doc and Javadoc for dynamic configs #21384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
see-quick wants to merge 7 commits into
base: trunk
Choose a base branch
from
+15 −6
Open

KAFKA-20110 Fix generated doc and Javadoc for dynamic configs #21384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2422e85
[KAFKA-20110] Fix DynamicQuotaConfig
see-quick Feb 2, 2026
19e320e
fix the stuff
see-quick Feb 5, 2026
f3e0032
update KafkaConfig to also generate dynamic-only configs into website…
see-quick Feb 10, 2026
36830ea
rebase
see-quick Feb 10, 2026
57e12f6
lining tweak
see-quick Feb 10, 2026
01480f4
make it cluster-level not per-broker
see-quick Feb 10, 2026
f69c1d5
update to comment
see-quick Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion core/src/main/scala/kafka/server/KafkaConfig.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@ import scala.jdk.OptionConverters.RichOptional
object KafkaConfig {

def main(args: Array[String]): Unit = {
System.out.println(configDef.toHtml(4, (config: String) => "brokerconfigs_" + config,
val combined = new ConfigDef(configDef)
// Broker quota configs are dynamic-only and not defined in AbstractKafkaConfig.CONFIG_DEF,
// so we need to add them explicitly here for the generated HTML documentation.
QuotaConfig.brokerQuotaConfigs().configKeys().forEach((_, v) => combined.define(v))
Copy link
Member

@chia7712 chia7712 Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would you mind adding comment?

Copy link
Contributor Author

@see-quick see-quick Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that would be good idea, I have added comment there.

System.out.println(combined.toHtml(4, (config: String) => "brokerconfigs_" + config,
JDynamicBrokerConfig.dynamicConfigUpdateModes))
}

Expand Down
2 changes: 1 addition & 1 deletion server-common/src/main/java/org/apache/kafka/server/config/QuotaConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public static ConfigDef brokerQuotaConfigs() {
ConfigDef.Importance.MEDIUM, QuotaConfig.REPLICA_ALTER_LOG_DIRS_IO_MAX_BYTES_PER_SECOND_DOC);
}

public static final Set<String> BROKER_QUOTA_CONFIGS = Set.copyOf(brokerQuotaConfigs().names());
public static final Set<String> BROKER_QUOTA_CONFIGS = Set.copyOf(brokerQuotaConfigs().names());

public static ConfigDef userAndClientQuotaConfigs() {
ConfigDef configDef = new ConfigDef();
Expand Down
8 changes: 6 additions & 2 deletions server/src/main/java/org/apache/kafka/server/config/DynamicBrokerConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ public class DynamicBrokerConfig {
DynamicReplicationConfig.RECONFIGURABLE_CONFIGS,
List.of(AbstractConfig.CONFIG_PROVIDERS_CONFIG),
GroupCoordinatorConfig.RECONFIGURABLE_CONFIGS,
ShareCoordinatorConfig.RECONFIGURABLE_CONFIGS,
QuotaConfig.BROKER_QUOTA_CONFIGS)
DynamicQuotaConfig.RECONFIGURABLE_CONFIGS,
ShareCoordinatorConfig.RECONFIGURABLE_CONFIGS)
.flatMap(Collection::stream)
.collect(Collectors.toUnmodifiableSet());

Expand Down Expand Up @@ -279,4 +279,8 @@ public static class DynamicReplicationConfig {
public static final Set<String> RECONFIGURABLE_CONFIGS = Set.of(
ReplicationConfigs.FOLLOWER_FETCH_LAST_TIERED_OFFSET_ENABLE_CONFIG);
}

public static class DynamicQuotaConfig {
Copy link
Member

@chia7712 chia7712 Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it a kind of decoration?

Copy link
Contributor Author

@see-quick see-quick Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think it make code more readable at least for me. Like I didn't want to re-write all these properties into Dynamic<class-name>.java:

public static final Set<String> ALL_DYNAMIC_CONFIGS = Stream.of(
            DYNAMIC_SECURITY_CONFIGS,
            LogCleaner.RECONFIGURABLE_CONFIGS,
            DynamicLogConfig.RECONFIGURABLE_CONFIGS,
            DynamicThreadPool.RECONFIGURABLE_CONFIGS,
            List.of(MetricConfigs.METRIC_REPORTER_CLASSES_CONFIG),
            DynamicListenerConfig.RECONFIGURABLE_CONFIGS,
            SocketServer.RECONFIGURABLE_CONFIGS,
            DYNAMIC_PRODUCER_STATE_MANAGER_CONFIGS,
            DynamicRemoteLogConfig.RECONFIGURABLE_CONFIGS,
            DynamicReplicationConfig.RECONFIGURABLE_CONFIGS,
            List.of(AbstractConfig.CONFIG_PROVIDERS_CONFIG),
            GroupCoordinatorConfig.RECONFIGURABLE_CONFIGS,
            DynamicQuotaConfig.RECONFIGURABLE_CONFIGS,
            ShareCoordinatorConfig.RECONFIGURABLE_CONFIGS)
        .flatMap(Collection::stream)
        .collect(Collectors.toUnmodifiableSet());

because you can see that some of them using that pattern DynamicThreadPool.RECONFIGURABLE_CONFIGS or DynamicLogConfig.RECONFIGURABLE_CONFIGS. Like for instance when seeing QuotaConfig.BROKER_QUOTA_CONFIGS it doesn't give me a feeling that it's dynamic configuration I have to go deep into the code to see it actually.... (maybe I am just too picky sorry :D)

public static final Set<String> RECONFIGURABLE_CONFIGS = QuotaConfig.BROKER_QUOTA_CONFIGS;
}
}
5 changes: 3 additions & 2 deletions server/src/main/java/org/apache/kafka/server/config/DynamicConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@
import java.util.Set;

/**
* Class used to hold dynamic configs. These are configs which have no physical manifestation in the server.properties
* and can only be set dynamically.
* Holds dynamic configs, including both dynamic-only configs which have no physical manifestation in server.properties and
* can only be set dynamically (i.e., {@link QuotaConfig#brokerQuotaConfigs()}), and dual-mode configs that can be set
* statically or dynamically.
*/
public class DynamicConfig {

Expand Down