KAFKA-17525: Convert the UnknownServerException to InvalidRequestException when altering client-metrics config at runtime #17168

TaiJuWu · 2024-09-11T19:57:53Z

As title
jira: https://issues.apache.org/jira/browse/KAFKA-17525

Committer Checklist (excluded from commit message)

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

TaiJuWu · 2024-09-12T03:37:04Z

All fail tests pass on my local.

chia7712

@TaiJuWu thanks for this quick fix.

core/src/test/java/kafka/admin/ConfigCommandIntegrationTest.java

chia7712 · 2024-09-13T09:23:09Z

server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java

@@ -131,9 +131,11 @@ private static void validateProperties(Properties properties) {
            }
        });

+        ClientMetricsConfigs configs = new ClientMetricsConfigs(properties);


What happens if there are configs having no default value?

Hi @chia7712 , thanks for review.

The situation won't happen because Line 120 checks the properties which are defined at Line 102 and they have default value except PUSH_INTERVAL_MS.

I am not convinced instantiating ClientMetricsConfigs(properties) in the validate method. The idea with validate is to create ClientMetricsConfigs instance only after post validating the configs are correct.

I understand we want to thrown invalid request exception when configs are not correct and as per the changes I am assuming that the unknown server occurs when the int config is specified as non-int, correct? If that's the only scenario then we can handle directly. Am I reading something wrong here?

I am not convinced instantiating ClientMetricsConfigs(properties) in the validate method. The idea with validate is to create ClientMetricsConfigs instance only after post validating the configs are correct.

I understand we want to thrown invalid request exception when configs are not correct and as per the changes I am assuming that the unknown server occurs when the int config is specified as non-int, correct? If that's the only scenario then we can handle directly. Am I reading something wrong here?

Yes, you are right and I updated this part by utilize ConfigDef.parseType.
PTAL.

frankvicky

Hi @TaiJuWu
I have a minor comment, PTAL

core/src/test/java/kafka/admin/ConfigCommandIntegrationTest.java

apoorvmittal10

Thanks for updating the PR. Left some comments.

apoorvmittal10 · 2024-09-26T21:04:46Z

server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java

-            int pushIntervalMs = Integer.parseInt(properties.getProperty(PUSH_INTERVAL_MS));
-            if (pushIntervalMs < MIN_INTERVAL_MS || pushIntervalMs > MAX_INTERVAL_MS) {
+            Integer pushIntervalMs = (Integer) ConfigDef.parseType(PUSH_INTERVAL_MS, properties.getProperty(PUSH_INTERVAL_MS), Type.INT);
+            if (pushIntervalMs == null || pushIntervalMs < MIN_INTERVAL_MS || pushIntervalMs > MAX_INTERVAL_MS) {


Hmmm, what happens when we use kafka-client-metrics.sh tool to just update pattern or metrics i.e. pushIntervalMs is not updated? Then isn't pushIntervalMs not null?

Hi @apoorvmittal10, thanks for the review and sorry for late response.

If kafka-client-metrics.sh doesn't have pushIntervalMs, it should not enter this block (check in 136).
I added a null check just to ensure that null values are handled properly and suppress compiler warning.
Ideally, the check should always pass.

apoorvmittal10 · 2024-09-26T21:14:19Z

server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java

@@ -133,8 +134,8 @@ private static void validateProperties(Properties properties) {

        // Make sure that push interval is between 100ms and 1 hour.
        if (properties.containsKey(PUSH_INTERVAL_MS)) {
-            int pushIntervalMs = Integer.parseInt(properties.getProperty(PUSH_INTERVAL_MS));
-            if (pushIntervalMs < MIN_INTERVAL_MS || pushIntervalMs > MAX_INTERVAL_MS) {
+            Integer pushIntervalMs = (Integer) ConfigDef.parseType(PUSH_INTERVAL_MS, properties.getProperty(PUSH_INTERVAL_MS), Type.INT);


If I get it right, the issue we are trying to solve is regarding the correct exception when config is not as INT or expected? If that's the case then either of the 3 approach I think would be better:

Make this method non-static, instance method. And remove properties as input. Then instantiate ClientMetricsConfig where they are used and call validate. The downside of this is that validation also happens in ControllerConfigurationValidator where unnecessary ClientMetricsConfig will be created.

Enclose a try/catch in validate method and return what received in exception but can return config exception where exception translates to UnknownServer Exception. This is not very clean but a good way to handle.

Use CONFIG.parse(properties) in validate method to get Map<?,?> valueMaps = CONFIG.parse(properties); and then iterate on map as like we iterate on properties. That shall solve your problem.

I would have chosen option 3. Also if you detail on the prolem satetment in PR description or jira then I can help better. But as far as I think, option 3 might solve your issue.

I saw the updated jira, thank you. Let me know if option 3 works for you, ideally should.

Hi @apoorvmittal10 , sorry for late response.
I have updated this PR according your great suggestion.
Please take a look.

apoorvmittal10

Thanks for addressing comments, some additional changes we can do.

server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java

apoorvmittal10 · 2024-09-29T20:29:05Z

server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java

+        Map<String, String> propertiesMap = new HashMap<>(properties.size());
+        properties.forEach((key, value) -> propertiesMap.put((String) key, (String) value));
+        Map<String, Object> parsed = CONFIG.parse(propertiesMap);


Do we need to create a map or should just write below:

Suggested change

Map<String, String> propertiesMap = new HashMap<>(properties.size());

properties.forEach((key, value) -> propertiesMap.put((String) key, (String) value));

Map<String, Object> parsed = CONFIG.parse(propertiesMap);

Map<String, Object> parsed = CONFIG.parse(properties);

nit: You can also write:

Map<?, ?> parsed = CONFIG.parse(properties);

Thanks for the suggestion. I hadn’t noticed this before.

apoorvmittal10

Thanks for addressing the comments, LGTM!. Minor nit test comments.

apoorvmittal10 · 2024-09-30T06:58:57Z

core/src/test/java/kafka/admin/ClientTelemetryTest.java

@@ -124,6 +128,20 @@ public void testClientInstanceId(ClusterInstance clusterInstance) throws Interru
        }
    }

+    private static String[] toArray(List<String>... lists) {
+        return Stream.of(lists).flatMap(List::stream).toArray(String[]::new);
+    }


nit: a line break

apoorvmittal10 · 2024-09-30T07:01:03Z

core/src/test/java/kafka/admin/ClientTelemetryTest.java

+    private static String[] toArray(List<String>... lists) {
+        return Stream.of(lists).flatMap(List::stream).toArray(String[]::new);
+    }


nit: would be better to place the private method after public methods and before static inner class.

Thanks. I will notice in future.

apoorvmittal10

LGTM! Thanks for the PR and addressing the comments.

…tion when altering client-metrics config at runtime (apache#17168) Reviewers: Apoorv Mittal <[email protected]>, TengYao Chi <[email protected]>, Chia-Ping Tsai <[email protected]>

fix config parser

d3dca3c

chia7712 reviewed Sep 13, 2024

View reviewed changes

core/src/test/java/kafka/admin/ConfigCommandIntegrationTest.java Outdated Show resolved Hide resolved

chia7712 reviewed Sep 13, 2024

View reviewed changes

frankvicky reviewed Sep 13, 2024

View reviewed changes

core/src/test/java/kafka/admin/ConfigCommandIntegrationTest.java Outdated Show resolved Hide resolved

address comments

1dd26e0

github-actions bot added the core Kafka Broker label Sep 26, 2024

frankvicky approved these changes Sep 26, 2024

View reviewed changes

TaiJuWu force-pushed the gh-KAFKA-17525 branch 2 times, most recently from 8f39965 to 1dd26e0 Compare September 26, 2024 04:56

TaiJuWu added 3 commits September 26, 2024 05:13

donot use ClientMetricsConfigs

764abc8

apply to match

ab68360

Merge branch 'trunk' into gh-KAFKA-17525

f766cbf

apoorvmittal10 reviewed Sep 26, 2024

View reviewed changes

mumrah added the ci-approved label Sep 27, 2024

TaiJuWu added 2 commits September 28, 2024 07:30

use CONFIG.parse

e58bfc7

fix build

e0d488a

apoorvmittal10 suggested changes Sep 29, 2024

View reviewed changes

TaiJuWu added 3 commits September 30, 2024 01:30

address comments

5d7e54a

Merge branch 'trunk' into gh-KAFKA-17525

a6242de

Merge branch 'trunk' into gh-KAFKA-17525

4882842

apoorvmittal10 approved these changes Sep 30, 2024

View reviewed changes

address comments

ed254f0

apoorvmittal10 approved these changes Sep 30, 2024

View reviewed changes

chia7712 approved these changes Oct 4, 2024

View reviewed changes

chia7712 merged commit 894c4a9 into apache:trunk Oct 4, 2024
9 checks passed

TaiJuWu deleted the gh-KAFKA-17525 branch October 4, 2024 02:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

KAFKA-17525: Convert the UnknownServerException to InvalidRequestException when altering client-metrics config at runtime #17168

KAFKA-17525: Convert the UnknownServerException to InvalidRequestException when altering client-metrics config at runtime #17168

TaiJuWu commented Sep 11, 2024 •

edited

Loading

TaiJuWu commented Sep 12, 2024 •

edited

Loading

chia7712 left a comment

chia7712 Sep 13, 2024

TaiJuWu Sep 14, 2024 •

edited

Loading

apoorvmittal10 Sep 25, 2024 •

edited

Loading

TaiJuWu Sep 26, 2024

frankvicky left a comment

apoorvmittal10 left a comment

apoorvmittal10 Sep 26, 2024 •

edited

Loading

TaiJuWu Sep 27, 2024 •

edited

Loading

apoorvmittal10 Sep 26, 2024 •

edited

Loading

apoorvmittal10 Sep 27, 2024 •

edited

Loading

TaiJuWu Sep 27, 2024

apoorvmittal10 left a comment

apoorvmittal10 Sep 29, 2024

apoorvmittal10 Sep 29, 2024 •

edited

Loading

TaiJuWu Sep 30, 2024

apoorvmittal10 left a comment

apoorvmittal10 Sep 30, 2024

apoorvmittal10 Sep 30, 2024

TaiJuWu Sep 30, 2024

apoorvmittal10 left a comment

KAFKA-17525: Convert the UnknownServerException to InvalidRequestException when altering client-metrics config at runtime #17168

KAFKA-17525: Convert the UnknownServerException to InvalidRequestException when altering client-metrics config at runtime #17168

Conversation

TaiJuWu commented Sep 11, 2024 • edited Loading

Committer Checklist (excluded from commit message)

TaiJuWu commented Sep 12, 2024 • edited Loading

chia7712 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TaiJuWu Sep 14, 2024 • edited Loading

Choose a reason for hiding this comment

apoorvmittal10 Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frankvicky left a comment

Choose a reason for hiding this comment

apoorvmittal10 left a comment

Choose a reason for hiding this comment

apoorvmittal10 Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

TaiJuWu Sep 27, 2024 • edited Loading

Choose a reason for hiding this comment

apoorvmittal10 Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

apoorvmittal10 Sep 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apoorvmittal10 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apoorvmittal10 Sep 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apoorvmittal10 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apoorvmittal10 left a comment

Choose a reason for hiding this comment

TaiJuWu commented Sep 11, 2024 •

edited

Loading

TaiJuWu commented Sep 12, 2024 •

edited

Loading

TaiJuWu Sep 14, 2024 •

edited

Loading

apoorvmittal10 Sep 25, 2024 •

edited

Loading

apoorvmittal10 Sep 26, 2024 •

edited

Loading

TaiJuWu Sep 27, 2024 •

edited

Loading

apoorvmittal10 Sep 26, 2024 •

edited

Loading

apoorvmittal10 Sep 27, 2024 •

edited

Loading

apoorvmittal10 Sep 29, 2024 •

edited

Loading