Add support for the Strimzi Metrics Reporter to Kafka brokers/controllers components #11051
There are no files selected for viewing
This file contains 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 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 |
|---|---|---|
|
|
@@ -5,7 +5,6 @@ | |
| package io.strimzi.api.kafka.model.common.metrics; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonPropertyOrder; | ||
| import io.strimzi.api.kafka.model.common.Constants; | ||
| import io.strimzi.api.kafka.model.common.ExternalConfigurationReference; | ||
|
|
@@ -31,7 +30,6 @@ public class JmxPrometheusExporterMetrics extends MetricsConfig { | |
| private ExternalConfigurationReference valueFrom; | ||
|
|
||
| @Description("ConfigMap entry where the Prometheus JMX Exporter configuration is stored. ") | ||
|
There was a problem hiding this comment. IIRC, you had to make it optional because of how the API is constructed. But it is required. So, we have to make sure:
There was a problem hiding this comment. FYI: I opened #11068 for the CEL validation. Once/if merged, you would need to add the corresponding rule here. |
||
| public ExternalConfigurationReference getValueFrom() { | ||
| return valueFrom; | ||
| } | ||
|
|
||
This file contains 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 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,46 @@ | ||
| /* | ||
| * Copyright Strimzi authors. | ||
| * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html). | ||
| */ | ||
| package io.strimzi.api.kafka.model.common.metrics; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonPropertyOrder; | ||
| import io.strimzi.api.kafka.model.common.Constants; | ||
| import io.strimzi.crdgenerator.annotations.Description; | ||
| import io.sundr.builder.annotations.Buildable; | ||
| import lombok.EqualsAndHashCode; | ||
| import lombok.ToString; | ||
|
|
||
| /** | ||
| * Strimzi Metrics Reporter. | ||
| */ | ||
| @Buildable( | ||
| editableEnabled = false, | ||
| builderPackage = Constants.FABRIC8_KUBERNETES_API | ||
| ) | ||
| @JsonPropertyOrder({"type", "values"}) | ||
| @JsonInclude(JsonInclude.Include.NON_NULL) | ||
| @EqualsAndHashCode(callSuper = true) | ||
| @ToString(callSuper = true) | ||
| public class StrimziMetricsReporter extends MetricsConfig { | ||
| public static final String TYPE_STRIMZI_METRICS_REPORTER = "strimziMetricsReporter"; | ||
|
|
||
| private StrimziMetricsReporterValues values; | ||
|
|
||
| @Description("Must be `" + TYPE_STRIMZI_METRICS_REPORTER + "`") | ||
| @JsonInclude(JsonInclude.Include.NON_NULL) | ||
| @Override | ||
| public String getType() { | ||
| return TYPE_STRIMZI_METRICS_REPORTER; | ||
| } | ||
|
|
||
| @Description("Configuration values for the Strimzi Metrics Reporter.") | ||
| public StrimziMetricsReporterValues getValues() { | ||
| return values; | ||
| } | ||
|
|
||
| public void setValues(StrimziMetricsReporterValues values) { | ||
| this.values = values; | ||
| } | ||
| } |
This file contains 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,59 @@ | ||
| /* | ||
| * Copyright Strimzi authors. | ||
| * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html). | ||
| */ | ||
| package io.strimzi.api.kafka.model.common.metrics; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonPropertyOrder; | ||
| import io.strimzi.api.kafka.model.common.Constants; | ||
| import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving; | ||
| import io.strimzi.crdgenerator.annotations.Description; | ||
| import io.sundr.builder.annotations.Buildable; | ||
| import lombok.EqualsAndHashCode; | ||
| import lombok.ToString; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Strimzi Metrics Reporter configuration. | ||
| */ | ||
| @Buildable( | ||
| editableEnabled = false, | ||
| builderPackage = Constants.FABRIC8_KUBERNETES_API | ||
| ) | ||
| @JsonInclude(JsonInclude.Include.NON_NULL) | ||
| @JsonPropertyOrder({"allowList"}) | ||
| @EqualsAndHashCode() | ||
| @ToString | ||
| public class StrimziMetricsReporterValues implements UnknownPropertyPreserving { | ||
| private static final String DEFAULT_REGEX = ".*"; | ||
|
There was a problem hiding this comment. I think we should have the default tailor-made for each component. (Or it should be required) And the allow list should default to null to allow you to distinguish between not set and set to |
||
|
|
||
| private List<String> allowList = List.of(DEFAULT_REGEX); | ||
| private Map<String, Object> additionalProperties; | ||
|
|
||
| @Description("A comma separated list of regex patterns to specify the metrics to collect. Default: `" + DEFAULT_REGEX + "`.") | ||
| @JsonInclude(value = JsonInclude.Include.NON_NULL) | ||
| public List<String> getAllowList() { | ||
| return allowList; | ||
| } | ||
|
|
||
| public void setAllowList(List<String> allowList) { | ||
| this.allowList = allowList; | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, Object> getAdditionalProperties() { | ||
| return this.additionalProperties != null ? this.additionalProperties : Map.of(); | ||
| } | ||
|
|
||
| @Override | ||
| public void setAdditionalProperty(String name, Object value) { | ||
| if (this.additionalProperties == null) { | ||
| this.additionalProperties = new HashMap<>(2); | ||
| } | ||
| this.additionalProperties.put(name, value); | ||
| } | ||
| } | ||
This file contains 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 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 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.
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.
I would leave this sentence out. It is confusing.