flume-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hshreedha...@apache.org
Subject git commit: FLUME-1834. Flume Userguide is missing some memory channel props.
Date Sat, 26 Jan 2013 01:07:30 GMT
Updated Branches:
  refs/heads/trunk f06a44bdc -> 40043fe2f


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/40043fe2
Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/40043fe2
Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/40043fe2

Branch: refs/heads/trunk
Commit: 40043fe2f5ebc74f55c2a50f3ac04bb4f887833d
Parents: f06a44b
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:05:23 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/40043fe2/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:
 


Mime
View raw message