You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flume.apache.org by hs...@apache.org on 2012/06/21 21:55:44 UTC
svn commit: r1352662 -
/incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst
Author: hshreedharan
Date: Thu Jun 21 19:55:43 2012
New Revision: 1352662
URL: http://svn.apache.org/viewvc?rev=1352662&view=rev
Log:
FLUME-1300. Update File Channel documentation in Flume User Guide.
(Arvind Prabhakar via Hari Shreedharan)
Modified:
incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst
Modified: incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst
URL: http://svn.apache.org/viewvc/incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst?rev=1352662&r1=1352661&r2=1352662&view=diff
==============================================================================
--- incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst (original)
+++ incubator/flume/trunk/flume-ng-doc/sphinx/FlumeUserGuide.rst Thu Jun 21 19:55:43 2012
@@ -1010,18 +1010,29 @@ wal.maxLogsSize (0x20000000)
File Channel
~~~~~~~~~~~~
-.. note:: The File Channel is still undergoing testing and is not yet considered
- to be as stable as the Memory Channel.
-
Required properties are in **bold**.
-============= ======= ==============================================
-Property Name Default Description
-============= ======= ==============================================
-**type** -- The component type name, needs to be ``FILE``.
-(TBD) --
-============= ======= ==============================================
-
+==================== ================================ ========================================================
+Property Name Default Description
+==================== ================================ ========================================================
+**type** -- The component type name, needs to be ``FILE``.
+checkpointDir ~/.flume/file-channel/checkpoint The directory where checkpoint file will be stored
+dataDirs ~/.flume/file-channel/data The directory where log files will be stored
+transactionCapacity 1000 The maximum size of transaction supported by the channel
+checkpointInterval 30000 Amount of time (in millis) between checkpoints
+maxFileSize 2146435071 Max size (in bytes) of a single log file
+capacity 1000000 Maximum capacity of the channel
+keep-alive 3 Amount of time (in sec) to wait for a put operation
+write-timeout 3 Amount of time (in sec) to wait for a write operation
+==================== ================================ ========================================================
+
+.. note:: By default the File Channel uses paths for checkpoint and data
+ directories that are within the user home as specified above.
+ As a result if you have more than one File Channel instances
+ active within the agent, only one will be able to lock the
+ directories and cause the other channel initialization to fail.
+ It is therefore necessary that you provide explicit paths to
+ all the configured channels, preferably on different disks.
Pseudo Transaction Channel
~~~~~~~~~~~~~~~~~~~~~~~~~~