-
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
base: trunk
Are you sure you want to change the base?
Changes from all commits
563f347
08dff59
9e221e3
1dd8f41
204c8a9
96fd5a6
6ef4001
44ecfdb
e26a06f
27d9a55
b92a2bb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -209,16 +209,17 @@ public Worker( | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
private WorkerConfigTransformer initConfigTransformer() { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
final List<String> providerNames = config.getList(WorkerConfig.CONFIG_PROVIDERS_CONFIG); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Map<String, ConfigProvider> providerMap = new HashMap<>(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Map<String, Plugin<ConfigProvider>> providerPluginMap = new HashMap<>(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
for (String providerName : providerNames) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfigProvider configProvider = plugins.newConfigProvider( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WorkerConfig.CONFIG_PROVIDERS_CONFIG + "." + providerName, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClassLoaderUsage.PLUGINS | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Plugin<ConfigProvider> configProviderPlugin = plugins.newConfigProvider( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerName, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClassLoaderUsage.PLUGINS, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
metrics.metrics() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerMap.put(providerName, configProvider); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
providerPluginMap.put(providerName, configProviderPlugin); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return new WorkerConfigTransformer(this, providerMap); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return new WorkerConfigTransformer(this, providerPluginMap); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment on lines
210
to
223
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Guard against resource leaks when provider instantiation fails
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
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public WorkerConfigTransformer configTransformer() { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.
Security Issue: The
MonitorableConfigProvider
implementation adds metrics without validating the metrics source. Even in test code, this could serve as a template for real implementations. Consider adding validation to ensure metrics are from a trusted source before adding them: