Add an option to log container properties

https://stackoverflow.com/questions/47914528/how-to-print-spring-kafka-configurations-in-logs-using-log4j/47914975#comment82800055_47914975

* Polishing - PR Comments

Author: garyrussell

spring-kafka/src/main/java/org/springframework/kafka/listener/KafkaMessageListenerContainer.java

@@ -364,7 +364,7 @@ private final class ListenerConsumer implements SchedulingAwareRunnable, Consume
 
 		private final String consumerGroupId = this.containerProperties.getGroupId() == null
 				? (String) KafkaMessageListenerContainer.this.consumerFactory.getConfigurationProperties()
-				.get(ConsumerConfig.GROUP_ID_CONFIG)
+					.get(ConsumerConfig.GROUP_ID_CONFIG)
 				: this.containerProperties.getGroupId();
 
 		private final TaskScheduler taskScheduler;
@@ -463,6 +463,9 @@ else if (listener instanceof MessageListener) {
 			}
 			this.monitorTask = this.taskScheduler.scheduleAtFixedRate(() -> checkConsumer(),
 					this.containerProperties.getMonitorInterval() * 1000);
+			if (this.containerProperties.isLogContainerConfig() && this.logger.isInfoEnabled()) {
+				this.logger.info(this);
+			}
 		}
 
 		protected void checkConsumer() {
@@ -1260,6 +1263,19 @@ public void seekToEnd(String topic, int partition) {
 			this.seeks.add(new TopicPartitionInitialOffset(topic, partition, SeekPosition.END));
 		}
 
+		@Override
+		public String toString() {
+			return "KafkaMessageListenerContainer.ListenerConsumer ["
+					+ "containerProperties=" + this.containerProperties
+					+ ", listenerType=" + this.listenerType
+					+ ", isConsumerAwareListener=" + this.isConsumerAwareListener
+					+ ", isBatchListener=" + this.isBatchListener
+					+ ", autoCommit=" + this.autoCommit
+					+ ", consumerGroupId=" + this.consumerGroupId
+					+ ", clientIdSuffix=" + KafkaMessageListenerContainer.this.clientIdSuffix
+					+ "]";
+		}
+
 		private final class ConsumerAcknowledgment implements Acknowledgment {
 
 			private final ConsumerRecord<K, V> record;

spring-kafka/src/main/java/org/springframework/kafka/listener/config/ContainerProperties.java

@@ -33,6 +33,7 @@
 import org.springframework.scheduling.TaskScheduler;
 import org.springframework.transaction.PlatformTransactionManager;
 import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
 
 /**
  * Contains runtime properties for a listener container.
@@ -159,6 +160,8 @@ public class ContainerProperties {
 
 	private String clientId = "";
 
+	private boolean logContainerConfig;
+
 	public ContainerProperties(String... topics) {
 		Assert.notEmpty(topics, "An array of topicPartitions must be provided");
 		this.topics = Arrays.asList(topics).toArray(new String[topics.length]);
@@ -204,6 +207,7 @@ public void setMessageListener(Object messageListener) {
 	 * @param ackMode the {@link AckMode}; default BATCH.
 	 */
 	public void setAckMode(AbstractMessageListenerContainer.AckMode ackMode) {
+		Assert.notNull(ackMode, "'ackMode' cannot be null");
 		this.ackMode = ackMode;
 	}
 
@@ -483,4 +487,55 @@ public void setClientId(String clientId) {
 		this.clientId = clientId;
 	}
 
+	/**
+	 * Log the container configuration if true (INFO).
+	 * @return true to log.
+	 * @since 2.0.1
+	 */
+	public boolean isLogContainerConfig() {
+		return this.logContainerConfig;
+	}
+
+	/**
+	 * Set to true to instruct each container to log this configuration.
+	 * @param logContainerConfig true to log.
+	 * @since 2.1.1
+	 */
+	public void setLogContainerConfig(boolean logContainerConfig) {
+		this.logContainerConfig = logContainerConfig;
+	}
+
+	@Override
+	public String toString() {
+		return "ContainerProperties ["
+				+ (this.topics != null ? "topics=" + Arrays.toString(this.topics) : "")
+				+ (this.topicPattern != null ? ", topicPattern=" + this.topicPattern : "")
+				+ (this.topicPartitions != null
+						? ", topicPartitions=" + Arrays.toString(this.topicPartitions) : "")
+				+ ", ackMode=" + this.ackMode
+				+ ", ackCount=" + this.ackCount
+				+ ", ackTime=" + this.ackTime
+				+ ", messageListener=" + this.messageListener
+				+ ", pollTimeout=" + this.pollTimeout
+				+ (this.consumerTaskExecutor != null
+						? ", consumerTaskExecutor=" + this.consumerTaskExecutor : "")
+				+ (this.errorHandler != null ? ", errorHandler=" + this.errorHandler : "")
+				+ ", shutdownTimeout=" + this.shutdownTimeout
+				+ (this.consumerRebalanceListener != null
+						? ", consumerRebalanceListener=" + this.consumerRebalanceListener : "")
+				+ (this.commitCallback != null ? ", commitCallback=" + this.commitCallback : "")
+				+ ", syncCommits=" + this.syncCommits
+				+ ", ackOnError=" + this.ackOnError
+				+ ", idleEventInterval="
+						+ (this.idleEventInterval == null ? "not enabled" : this.idleEventInterval)
+				+ (this.groupId != null ? ", groupId=" + this.groupId : "")
+				+ (this.transactionManager != null
+						? ", transactionManager=" + this.transactionManager : "")
+				+ ", monitorInterval=" + this.monitorInterval
+				+ (this.scheduler != null ? ", scheduler=" + this.scheduler : "")
+				+ ", noPollThreshold=" + this.noPollThreshold
+				+ (StringUtils.hasText(this.clientId) ? ", clientId=" + this.clientId : "")
+				+ "]";
+	}
+
 }

spring-kafka/src/test/java/org/springframework/kafka/listener/ConcurrentMessageListenerContainerTests.java

@@ -102,6 +102,7 @@ public void testAutoCommit() throws Exception {
 		Map<String, Object> props = KafkaTestUtils.consumerProps("test1", "true", embeddedKafka);
 		DefaultKafkaConsumerFactory<Integer, String> cf = new DefaultKafkaConsumerFactory<>(props);
 		ContainerProperties containerProps = new ContainerProperties(topic1);
+		containerProps.setLogContainerConfig(true);
 
 		final CountDownLatch latch = new CountDownLatch(4);
 		final Set<String> listenerThreadNames = new ConcurrentSkipListSet<>();

src/reference/asciidoc/kafka.adoc

@@ -496,6 +496,8 @@ return container;
 
 Refer to the JavaDocs for `ContainerProperties` for more information about the various properties that can be set.
 
+Since version _2.1.1_, a new property `logContainerConfig` is available; when true, and INFO logging is enabled, each listener container will write a log message summarizing its configuration properties.
+
 ====== ConcurrentMessageListenerContainer
 
 The single constructor is similar to the first `KafkaListenerContainer` constructor: