[kafka] branch 3.1 updated: MINOR: Clarify logging behavior with errors.log.include.messages property (#11758)

[rhauch]

This is an automated email from the ASF dual-hosted git repository.

rhauch pushed a commit to branch 3.1
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/3.1 by this push:
     new 26f1c5f  MINOR: Clarify logging behavior with 
errors.log.include.messages property (#11758)
26f1c5f is described below

commit 26f1c5f91e6d479889dfe5a897ae2de96c576ec0
Author: Chris Egerton <fearthecel...@gmail.com>
AuthorDate: Mon Feb 21 08:55:04 2022 -0500

    MINOR: Clarify logging behavior with errors.log.include.messages property 
(#11758)
    
    The docs are a little misleading and some users can be confused about the 
exact behavior of this property.
---
 .../java/org/apache/kafka/connect/runtime/ConnectorConfig.java    | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git 
a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectorConfig.java
 
b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectorConfig.java
index 4ba1ddd..2f83284 100644
--- 
a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectorConfig.java
+++ 
b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectorConfig.java
@@ -150,9 +150,11 @@ public class ConnectorConfig extends AbstractConfig {
     public static final String ERRORS_LOG_INCLUDE_MESSAGES_CONFIG = 
"errors.log.include.messages";
     public static final String ERRORS_LOG_INCLUDE_MESSAGES_DISPLAY = "Log 
Error Details";
     public static final boolean ERRORS_LOG_INCLUDE_MESSAGES_DEFAULT = false;
-    public static final String ERRORS_LOG_INCLUDE_MESSAGES_DOC = "Whether to 
the include in the log the Connect record that resulted in " +
-            "a failure. This is 'false' by default, which will prevent record 
keys, values, and headers from being written to log files, " +
-            "although some information such as topic and partition number will 
still be logged.";
+    public static final String ERRORS_LOG_INCLUDE_MESSAGES_DOC = "Whether to 
include in the log the Connect record that resulted in a failure." +
+            "For sink records, the topic, partition, offset, and timestamp 
will be logged. " +
+            "For source records, the key and value (and their schemas), all 
headers, and the timestamp, Kafka topic, Kafka partition, source partition, " +
+            "and source offset will be logged. " +
+            "This is 'false' by default, which will prevent record keys, 
values, and headers from being written to log files.";
 
 
     public static final String CONNECTOR_CLIENT_PRODUCER_OVERRIDES_PREFIX = 
"producer.override.";