Improve Kafka appender documentation.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/34ee617a
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/34ee617a
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/34ee617a

Branch: 
refs/heads/LOG4J2-1010&LOG4J2-1447-injectable-contextdata&better-datastructure
Commit: 34ee617a3d667f36b21732a5e274c420183fa010
Parents: 714bfaf
Author: Mikael Ståldal <mikael.stal...@magine.com>
Authored: Mon Aug 8 10:35:02 2016 +0200
Committer: Mikael Ståldal <mikael.stal...@magine.com>
Committed: Mon Aug 8 10:35:02 2016 +0200

----------------------------------------------------------------------
 src/site/xdoc/manual/appenders.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/34ee617a/src/site/xdoc/manual/appenders.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/appenders.xml 
b/src/site/xdoc/manual/appenders.xml
index c04c491..51caab6 100644
--- a/src/site/xdoc/manual/appenders.xml
+++ b/src/site/xdoc/manual/appenders.xml
@@ -1261,7 +1261,7 @@ public class JpaLogEntity extends 
AbstractLogEventWrapperEntity {
         </subsection>
         <a name="KafkaAppender"/>
         <subsection name="KafkaAppender">
-          <p>The KafkaAppender logs events to an <a 
href="https://kafka.apache.org/";>Apache Kafka</a> topic.</p>
+          <p>The KafkaAppender logs events to an <a 
href="https://kafka.apache.org/";>Apache Kafka</a> topic.</p> Each log event is 
sent as a Kafka record with no key.
           <table>
             <caption align="top">KafkaAppender Parameters</caption>
             <tr>
@@ -1306,8 +1306,9 @@ public class JpaLogEntity extends 
AbstractLogEventWrapperEntity {
               <td>properties</td>
               <td>Property[]</td>
               <td>
-                You can set any properties in <a 
href="http://kafka.apache.org/documentation.html#producerconfigs";>Kafka 
producer properties</a>.
+                You can set properties in <a 
href="http://kafka.apache.org/documentation.html#producerconfigs";>Kafka 
producer properties</a>.
                 You need to set the <code>bootstrap.servers</code> property, 
there are sensible default values for the others.
+                Do not set the <code>value.serializer</code> property.
               </td>
             </tr>
           </table>

Reply via email to