ISSUE-9231 Makes Kafka Exporter offset.show-all configurable

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.40.0
 
 * Fix NullPointerException from missing listenerConfig when using custom auth
+* Added support for Kafka Exporter `offset.show-all` parameter
 
 ### Changes, deprecations and removals
 

api/src/main/java/io/strimzi/api/kafka/model/KafkaExporterSpec.java

@@ -29,7 +29,7 @@
     "image", "groupRegex", "topicRegex", 
     "groupExcludeRegex", "topicExcludeRegex",
     "resources", "logging",
-    "enableSaramaLogging", "template"})
+    "enableSaramaLogging", "showAllOffsets", "template"})
 @EqualsAndHashCode
 public class KafkaExporterSpec implements HasLivenessProbe, HasReadinessProbe, UnknownPropertyPreserving, Serializable {
     private static final long serialVersionUID = 1L;
@@ -45,6 +45,7 @@ public class KafkaExporterSpec implements HasLivenessProbe, HasReadinessProbe, U
     private Probe readinessProbe;
     private String logging = "info";
     private boolean enableSaramaLogging;
+    private boolean showAllOffsets = true;
     private KafkaExporterTemplate template;
     private Map<String, Object> additionalProperties = new HashMap<>(0);
 
@@ -112,6 +113,16 @@ public void setEnableSaramaLogging(boolean enableSaramaLogging) {
         this.enableSaramaLogging = enableSaramaLogging;
     }
 
+    @Description("Enable/disable offset show all option.")
+    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
+    public boolean getShowAllOffsets() {
+        return showAllOffsets;
+    }
+
+    public void setShowAllOffsets(boolean showAllOffsets) {
+        this.showAllOffsets = showAllOffsets;
+    }
+
     @Description("Only log messages with the given severity or above. " +
             "Valid levels: [`info`, `debug`, `trace`]. " +
             "Default log level is `info`.")

cluster-operator/src/main/java/io/strimzi/operator/cluster/model/KafkaExporter.java

@@ -64,6 +64,7 @@ public class KafkaExporter extends AbstractModel {
     protected static final String ENV_VAR_KAFKA_EXPORTER_TOPIC_EXCLUDE_REGEX = "KAFKA_EXPORTER_TOPIC_EXCLUDE_REGEX";
     protected static final String ENV_VAR_KAFKA_EXPORTER_KAFKA_SERVER = "KAFKA_EXPORTER_KAFKA_SERVER";
     protected static final String ENV_VAR_KAFKA_EXPORTER_ENABLE_SARAMA = "KAFKA_EXPORTER_ENABLE_SARAMA";
+    protected static final String ENV_VAR_KAFKA_EXPORTER_OFFSET_SHOW_ALL = "KAFKA_EXPORTER_OFFSET_SHOW_ALL";
 
     protected static final String CO_ENV_VAR_CUSTOM_KAFKA_EXPORTER_POD_LABELS = "STRIMZI_CUSTOM_KAFKA_EXPORTER_LABELS";
 
@@ -72,6 +73,7 @@ public class KafkaExporter extends AbstractModel {
     protected String groupExcludeRegex;
     protected String topicExcludeRegex;
     protected boolean saramaLoggingEnabled;
+    protected boolean showAllOffsets;
     /* test */ String exporterLogging;
     protected String version;
 
@@ -96,6 +98,7 @@ protected KafkaExporter(Reconciliation reconciliation, HasMetadata resource, Sha
         super(reconciliation, resource, KafkaExporterResources.deploymentName(resource.getMetadata().getName()), COMPONENT_TYPE, sharedEnvironmentProvider);
 
         this.saramaLoggingEnabled = false;
+        this.showAllOffsets = true;
     }
 
     /**
@@ -132,6 +135,7 @@ public static KafkaExporter fromCrd(Reconciliation reconciliation, Kafka kafkaAs
 
             result.exporterLogging = spec.getLogging();
             result.saramaLoggingEnabled = spec.getEnableSaramaLogging();
+            result.showAllOffsets = spec.getShowAllOffsets();
 
             if (spec.getTemplate() != null) {
                 KafkaExporterTemplate template = spec.getTemplate();
@@ -224,6 +228,7 @@ protected List<EnvVar> getEnvVars() {
         }
         varList.add(ContainerUtils.createEnvVar(ENV_VAR_KAFKA_EXPORTER_KAFKA_SERVER, KafkaResources.bootstrapServiceName(cluster) + ":" + KafkaCluster.REPLICATION_PORT));
         varList.add(ContainerUtils.createEnvVar(ENV_VAR_KAFKA_EXPORTER_ENABLE_SARAMA, String.valueOf(saramaLoggingEnabled)));
+        varList.add(ContainerUtils.createEnvVar(ENV_VAR_KAFKA_EXPORTER_OFFSET_SHOW_ALL, String.valueOf(showAllOffsets)));
 
         // Add shared environment variables used for all containers
         varList.addAll(sharedEnvironmentProvider.variables());

cluster-operator/src/test/java/io/strimzi/operator/cluster/model/KafkaExporterTest.java

@@ -93,6 +93,7 @@ public class KafkaExporterTest {
     private final String topicRegex = "my-topic-.*";
     private final String groupExcludeRegex = "my-group-exclude-.*";
     private final String topicExcludeRegex = "my-topic-exclude-.*";
+    private final boolean showAllOffsets = false;
 
     private final KafkaExporterSpec exporterOperator = new KafkaExporterSpecBuilder()
             .withLogging(exporterOperatorLogging)
@@ -102,6 +103,7 @@ public class KafkaExporterTest {
             .withTopicExcludeRegex(topicExcludeRegex)
             .withImage(keImage)
             .withEnableSaramaLogging(true)
+            .withShowAllOffsets(showAllOffsets)
             .withNewTemplate()
                 .withNewPod()
                     .withTmpDirSizeLimit("100Mi")
@@ -135,6 +137,7 @@ private List<EnvVar> getExpectedEnvVars() {
         expected.add(new EnvVarBuilder().withName(KafkaExporter.ENV_VAR_KAFKA_EXPORTER_TOPIC_EXCLUDE_REGEX).withValue(topicExcludeRegex).build());
         expected.add(new EnvVarBuilder().withName(KafkaExporter.ENV_VAR_KAFKA_EXPORTER_KAFKA_SERVER).withValue("foo-kafka-bootstrap:" + KafkaCluster.REPLICATION_PORT).build());
         expected.add(new EnvVarBuilder().withName(KafkaExporter.ENV_VAR_KAFKA_EXPORTER_ENABLE_SARAMA).withValue("true").build());
+        expected.add(new EnvVarBuilder().withName(KafkaExporter.ENV_VAR_KAFKA_EXPORTER_OFFSET_SHOW_ALL).withValue(String.valueOf(showAllOffsets)).build());
         return expected;
     }
 
@@ -152,6 +155,7 @@ public void testFromConfigMapDefaultConfig() {
         assertNull(ke.groupExcludeRegex);
         assertNull(ke.topicExcludeRegex);
         assertThat(ke.saramaLoggingEnabled, is(false));
+        assertThat(ke.showAllOffsets, is(true));
     }
 
     @ParallelTest
@@ -165,6 +169,7 @@ public void testFromConfigMap() {
         assertThat(ke.groupExcludeRegex, is("my-group-exclude-.*"));
         assertThat(ke.topicExcludeRegex, is("my-topic-exclude-.*"));
         assertThat(ke.saramaLoggingEnabled, is(true));
+        assertThat(ke.showAllOffsets, is(false));
     }
 
     @ParallelTest

docker-images/kafka-based/kafka/exporter-scripts/kafka_exporter_run.sh

@@ -30,6 +30,10 @@ if [ "$KAFKA_EXPORTER_ENABLE_SARAMA" = "true" ]; then
     saramaenable="--log.enable-sarama"
 fi
 
+if [ "$KAFKA_EXPORTER_OFFSET_SHOW_ALL" = "true" ]; then
+    allgroups="--offset.show-all"
+fi
+
 if [ -n "$KAFKA_EXPORTER_LOGGING" ]; then
     loglevel="--verbosity=${KAFKA_EXPORTER_LOGGING}"
 fi
@@ -48,8 +52,6 @@ kafkaserver="--kafka.server="$KAFKA_EXPORTER_KAFKA_SERVER
 
 listenaddress="--web.listen-address=:9404"
 
-allgroups="--offset.show-all"
-
 tls="--tls.enabled --tls.ca-file=$CA_CERTS --tls.cert-file=/etc/kafka-exporter/kafka-exporter-certs/kafka-exporter.crt  --tls.key-file=/etc/kafka-exporter/kafka-exporter-certs/kafka-exporter.key"
 
 # starting Kafka Exporter with final configuration

documentation/modules/appendix_crds.adoc

@@ -1578,6 +1578,8 @@ Used in: xref:type-KafkaSpec-{context}[`KafkaSpec`]
 |string
 |enableSaramaLogging  1.2+<.<a|Enable Sarama logging, a Go client library used by the Kafka Exporter.
 |boolean
+|showAllOffsets       1.2+<.<a|Enable/disable offset show all option.
+|boolean
 |template             1.2+<.<a|Customization of deployment templates and pods.
 |xref:type-KafkaExporterTemplate-{context}[`KafkaExporterTemplate`]
 |livenessProbe        1.2+<.<a|Pod liveness check.

packaging/helm-charts/helm3/strimzi-kafka-operator/crds/040-Crd-kafka.yaml

@@ -5599,6 +5599,9 @@ spec:
                     enableSaramaLogging:
                       type: boolean
                       description: "Enable Sarama logging, a Go client library used by the Kafka Exporter."
+                    showAllOffsets:
+                      type: boolean
+                      description: Enable/disable offset show all option.
                     template:
                       type: object
                       properties:

packaging/install/cluster-operator/040-Crd-kafka.yaml

@@ -5598,6 +5598,9 @@ spec:
                   enableSaramaLogging:
                     type: boolean
                     description: "Enable Sarama logging, a Go client library used by the Kafka Exporter."
+                  showAllOffsets:
+                    type: boolean
+                    description: Enable/disable offset show all option.
                   template:
                     type: object
                     properties: