Skip to content
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

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

Merged
merged 11 commits into from
Oct 4, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d3dca3c
fix config parser
TaiJuWu Sep 11, 2024
1dd26e0
address comments
TaiJuWu Sep 13, 2024
764abc8
donot use ClientMetricsConfigs
TaiJuWu Sep 26, 2024
ab68360
apply to match
TaiJuWu Sep 26, 2024
f766cbf
Merge branch 'trunk' into gh-KAFKA-17525
TaiJuWu Sep 26, 2024
e58bfc7
use CONFIG.parse
TaiJuWu Sep 27, 2024
e0d488a
fix build
TaiJuWu Sep 27, 2024
5d7e54a
address comments
TaiJuWu Sep 30, 2024
a6242de
Merge branch 'trunk' into gh-KAFKA-17525
TaiJuWu Sep 30, 2024
4882842
Merge branch 'trunk' into gh-KAFKA-17525
TaiJuWu Sep 30, 2024
ed254f0
address comments
TaiJuWu Sep 30, 2024
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
12 changes: 12 additions & 0 deletions core/src/test/java/kafka/admin/ConfigCommandIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import org.apache.kafka.server.config.ZooKeeperInternals;
import org.apache.kafka.test.TestUtils;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.platform.commons.util.StringUtils;

Expand Down Expand Up @@ -528,6 +529,17 @@ public void testUpdatePerBrokerConfigInKRaftThenShouldFail() {
}
}

@ClusterTest(types = {Type.CO_KRAFT, Type.KRAFT})
public void testIntervalMsParser() {
alterOpts = asList("--bootstrap-server", cluster.bootstrapServers(),
"--alter", "--entity-type", "client-metrics", "--entity-name", "test");
try (Admin client = cluster.createAdminClient()) {
Throwable e = assertThrows(ExecutionException.class, () ->
alterConfigWithKraft(client, Optional.of(defaultBrokerId), singletonMap("interval.ms", "aaa")));
Assertions.assertTrue(e.getMessage().contains("InvalidConfigurationException"));
}
}

private void assertNonZeroStatusExit(Stream<String> args, Consumer<String> checkErrOut) {
AtomicReference<Integer> exitStatus = new AtomicReference<>();
Exit.setExitProcedure((status, __) -> {
Expand Down
6 changes: 4 additions & 2 deletions server/src/main/java/org/apache/kafka/server/metrics/ClientMetricsConfigs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,11 @@ private static void validateProperties(Properties properties) {
}
});

ClientMetricsConfigs configs = new ClientMetricsConfigs(properties);
Copy link
Member

Choose a reason for hiding this comment

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

What happens if there are configs having no default value?

Copy link
Contributor Author

@TaiJuWu TaiJuWu Sep 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator

@apoorvmittal10 apoorvmittal10 Sep 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.


// 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));
int pushIntervalMs = configs.getInt(PUSH_INTERVAL_MS);
if (pushIntervalMs < MIN_INTERVAL_MS || pushIntervalMs > MAX_INTERVAL_MS) {
String msg = String.format("Invalid value %s for %s, interval must be between 100 and 3600000 (1 hour)",
pushIntervalMs, PUSH_INTERVAL_MS);
Expand All @@ -143,7 +145,7 @@ private static void validateProperties(Properties properties) {

// Make sure that client match patterns are valid by parsing them.
if (properties.containsKey(CLIENT_MATCH_PATTERN)) {
List<String> patterns = Arrays.asList(properties.getProperty(CLIENT_MATCH_PATTERN).split(","));
List<String> patterns = configs.getList(CLIENT_MATCH_PATTERN);
// Parse the client matching patterns to validate if the patterns are valid.
parseMatchingPatterns(patterns);
}
Expand Down