forked from apache/kafka
-
Notifications
You must be signed in to change notification settings - Fork 0
KAFKA-18894: Add KIP-877 support for ConfigProvider #14
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.
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
arvi18
wants to merge
11
commits into
trunk
Choose a base branch
from
clone-KAFKA-18894
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
563f347
KAFKA-18894: Add KIP-877 support for ConfigProvider
Yunyung 08dff59
spotlessApply
Yunyung 9e221e3
Update msg in Utils.closeQuietly
Yunyung 1dd8f41
Add a test to verify withPluginMetrics is called after configure
Yunyung 204c8a9
Refactor the test
Yunyung 96fd5a6
Refactor
Yunyung 6ef4001
Add a newline at the end of the file
Yunyung 44ecfdb
Fix NPE in transform method
Yunyung e26a06f
Remove debug print
Yunyung 27d9a55
Merge branch 'trunk' into KAFKA-18894
Yunyung b92a2bb
Address m1a2st comments
Yunyung File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
clients/src/test/java/org/apache/kafka/common/config/provider/MonitorableConfigProvider.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.kafka.common.config.provider; | ||
|
|
||
| import org.apache.kafka.common.MetricName; | ||
| import org.apache.kafka.common.config.ConfigData; | ||
| import org.apache.kafka.common.metrics.Measurable; | ||
| import org.apache.kafka.common.metrics.Monitorable; | ||
| import org.apache.kafka.common.metrics.PluginMetrics; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| public class MonitorableConfigProvider implements ConfigProvider, Monitorable { | ||
| public static final String NAME = "name"; | ||
| public static final String DESCRIPTION = "description"; | ||
| protected boolean configured = false; | ||
|
|
||
| @Override | ||
| public void withPluginMetrics(PluginMetrics metrics) { | ||
| MetricName metricName = metrics.metricName(NAME, DESCRIPTION, Map.of()); | ||
| metrics.addMetric(metricName, (Measurable) (config, now) -> 123); | ||
| } | ||
|
|
||
| @Override | ||
| public ConfigData get(String path) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public ConfigData get(String path, Set<String> keys) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
| } | ||
|
|
||
| @Override | ||
| public void configure(Map<String, ?> configs) { | ||
| configured = true; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Guard against resource leaks when provider instantiation fails
plugins.newConfigProvider(...)may throw (e.g. bad class‑name, constructor error).If that happens after a few providers are already created, those plugin instances stay open because
initConfigTransformer()aborts beforeworkerConfigTransformeris constructed and theclose()call that normally releases them is never reached.Consider wrapping the loop in a try/catch that closes any already‑created plugins before re‑throwing, e.g.:
Map<String, Plugin<ConfigProvider>> providerPluginMap = new HashMap<>(); try { for (String providerName : providerNames) { Plugin<ConfigProvider> configProviderPlugin = plugins.newConfigProvider( config, providerName, ClassLoaderUsage.PLUGINS, metrics.metrics()); providerPluginMap.put(providerName, configProviderPlugin); } } catch (Throwable t) { + providerPluginMap.values().forEach(p -> Utils.closeQuietly(p, "config provider plugin")); throw t; } return new WorkerConfigTransformer(this, Collections.unmodifiableMap(providerPluginMap));This keeps the constructor exception‑safe and prevents dangling threads/metrics.
📝 Committable suggestion