FLUME-2723 batch size trans cap doc update
authorEndre Major <emajor@cloudera.com>
Fri, 23 Nov 2018 10:13:57 +0000 (11:13 +0100)
committerFerenc Szabo <szaboferee@apache.org>
Fri, 23 Nov 2018 10:13:57 +0000 (11:13 +0100)
An update to the configuration section of the user guide.

This closes #246

Reviewers: Peret Turcsanyi, Ferenc Szabo

(Endre Major via Ferenc Szabo)

flume-ng-doc/sphinx/FlumeUserGuide.rst

index 58164a5..492d90e 100644 (file)
@@ -853,6 +853,15 @@ the commands including the passwords will be saved to the command history.)
   performed on the truststore when it is opened by the JDK.
 
 
+Source and sink batch sizes and channel transaction capacities
+--------------------------------------------------------------
+
+Sources and sinks can have a batch size parameter that determines the maximum number of events they
+process in one batch. This happens within a channel transaction that has an upper limit called
+transaction capacity. Batch size must be smaller than the channel's transaction capacity.
+There is an explicit check to prevent incompatible settings. This check happens
+whenever the configuration is read.
+
 Flume Sources
 -------------