Review Board 1.7.22


FLUME-1834: Userguide on trunk is missing some memory channel props

Review Request #8939 - Created Jan. 14, 2013 and submitted

Alexander Alten-Lorenz
FLUME-1834
Reviewers
Flume
flume-git
Userguide is missing:
byteCapacityBufferPercentage (default is 20)
byteCapacity (default seems to be 80% of -Xmx value, measured in bytes)

 

Diff revision 2 (Latest)

1 2
1 2

  1. flume-ng-doc/sphinx/FlumeUserGuide.rst: Loading...
flume-ng-doc/sphinx/FlumeUserGuide.rst
Revision 63b8f9b New Change
[20] 1634 lines
[+20]
1635
The events are stored in a an in-memory queue with configurable max size. It's
1635
The events are stored in a an in-memory queue with configurable max size. It's
1636
ideal for flow that needs higher throughput and prepared to lose the staged
1636
ideal for flow that needs higher throughput and prepared to lose the staged
1637
data in the event of a agent failures.
1637
data in the event of a agent failures.
1638
Required properties are in **bold**.
1638
Required properties are in **bold**.
1639

    
   
1639

   
1640
===================  =======  ==============================================================
1640
============================  =======  ===============================================================================
1641
Property Name        Default  Description
1641
Property Name                 Default  Description
1642
===================  =======  ==============================================================
1642
============================  =======  ===============================================================================
1643
**type**             --       The component type name, needs to be ``memory``
1643
**type**                      --       The component type name, needs to be ``memory``
1644
capacity             100      The max number of events stored in the channel
1644
capacity                      100      The max number of events stored in the channel
1645
transactionCapacity  100      The max number of events stored in the channel per transaction
1645
transactionCapacity           100      The max number of events stored in the channel per transaction
1646
keep-alive           3        Timeout in seconds for adding or removing an event
1646
keep-alive                    3        Timeout in seconds for adding or removing an event
1647
===================  =======  ==============================================================
1647
byteCapacityBufferPercentage  20       Defines the percent of buffer between byteCapacity and the estimated event size

    
   
1648
byteCapacity                  80       Max number of events in percent of -Xmx value, measured in bytes

    
   
1649
============================  =======  ===============================================================================
1648

    
   
1650

   
1649
Example for agent named a1:
1651
Example for agent named a1:
1650

    
   
1652

   
1651
.. code-block:: properties
1653
.. code-block:: properties
1652

    
   
1654

   
[+20] [20] 1105 lines
  1. flume-ng-doc/sphinx/FlumeUserGuide.rst: Loading...