[prev in list] [next in list] [prev in thread] [next in thread] 

List:       flume-commits
Subject:    git commit: FLUME-1834. Flume Userguide is missing some memory channel props.
From:       hshreedharan () apache ! org
Date:       2013-01-26 1:07:36
Message-ID: 20130126010736.164C2825B34 () tyr ! zones ! apache ! org
[Download RAW message or body]

Updated Branches:
  refs/heads/flume-1.4 272159163 -> 5876271c0


FLUME-1834. Flume Userguide is missing some memory channel props.

(Alexander Alten-Lorenz and Mike Percy via Hari Shreedharan)


Project: http://git-wip-us.apache.org/repos/asf/flume/repo
Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/5876271c
Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/5876271c
Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/5876271c

Branch: refs/heads/flume-1.4
Commit: 5876271c0fc7107eb5746d0feae6ffb4137c2bcd
Parents: 2721591
Author: Hari Shreedharan <harishreedharan@gmail.com>
Authored: Fri Jan 25 17:05:23 2013 -0800
Committer: Hari Shreedharan <harishreedharan@gmail.com>
Committed: Fri Jan 25 17:07:19 2013 -0800

----------------------------------------------------------------------
 flume-ng-doc/sphinx/FlumeUserGuide.rst |   29 +++++++++++++++++++-------
 1 files changed, 21 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flume/blob/5876271c/flume-ng-doc/sphinx/FlumeUserGuide.rst
                
----------------------------------------------------------------------
diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst \
b/flume-ng-doc/sphinx/FlumeUserGuide.rst index 8a7de6e..898de23 100644
--- a/flume-ng-doc/sphinx/FlumeUserGuide.rst
+++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst
@@ -1693,14 +1693,27 @@ ideal for flow that needs higher throughput and prepared to \
lose the staged  data in the event of a agent failures.
 Required properties are in **bold**.
 
-===================  =======  \
                ==============================================================
-Property Name        Default  Description
-===================  =======  \
                ==============================================================
-**type**             --       The component type name, needs to be ``memory``
-capacity             100      The max number of events stored in the channel
-transactionCapacity  100      The max number of events stored in the channel per \
                transaction
-keep-alive           3        Timeout in seconds for adding or removing an event
-===================  =======  \
============================================================== \
+============================  ================  \
=============================================================================== \
+Property Name                 Default           Description \
+============================  ================  \
=============================================================================== \
+**type**                      --                The component type name, needs to be \
``memory`` +capacity                      100               The max number of events \
stored in the channel +transactionCapacity           100               The max number \
of events stored in the channel per transaction +keep-alive                    3      \
Timeout in seconds for adding or removing an event +byteCapacityBufferPercentage  20  \
Defines the percent of buffer between byteCapacity and the estimated total size +     \
of all events in the channel, to account for data in headers. See below. \
+byteCapacity                  see description   Maximum total **bytes** of memory \
allowed as a sum of all events in this channel. +                                     \
The implementation only counts the Event ``body``, which is the reason for +          \
providing the ``byteCapacityBufferPercentage`` configuration parameter as well. +     \
Defaults to a computed value equal to 80% of the maximum memory available to +        \
the JVM (i.e. 80% of the -Xmx value passed on the command line). +                    \
Note that if you have multiple memory channels on a single JVM, and they happen +     \
to hold the same physical events (i.e. if you are using a replicating channel +       \
selector from a single source) then those event sizes may be double-counted for +     \
channel byteCapacity purposes. +                                                \
Setting this value to ``0`` will cause this value to fall back to a hard +            \
internal limit of about 200 GB. +============================  ================  \
===============================================================================  
 Example for agent named a1:
 


[prev in list] [next in list] [prev in thread] [next in thread]