Fix sphinx layout errors Minor syntax error fixes
Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/9965dae7 Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/9965dae7 Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/9965dae7 Branch: refs/heads/trunk Commit: 9965dae7bd384abd2e25fd1756dbe516e8acdb9b Parents: 0259d30 Author: Mike Percy <[email protected]> Authored: Tue Jul 19 13:33:58 2016 -0700 Committer: Mike Percy <[email protected]> Committed: Tue Jul 19 14:43:40 2016 -0700 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeUserGuide.rst | 92 ++++++++++++++--------------- 1 file changed, 46 insertions(+), 46 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/9965dae7/flume-ng-doc/sphinx/FlumeUserGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst b/flume-ng-doc/sphinx/FlumeUserGuide.rst index 3937514..d8bfebf 100644 --- a/flume-ng-doc/sphinx/FlumeUserGuide.rst +++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst @@ -976,53 +976,53 @@ Despite the reliability guarantees of this source, there are still cases in which events may be duplicated if certain downstream failures occur. This is consistent with the guarantees offered by other Flume components. -====================== ============== ========================================================== -Property Name Default Description -====================== ============== ========================================================== -**channels** -- -**type** -- The component type name, needs to be ``spooldir``. -**spoolDir** -- The directory from which to read files from. -fileSuffix .COMPLETED Suffix to append to completely ingested files -deletePolicy never When to delete completed files: ``never`` or ``immediate`` -fileHeader false Whether to add a header storing the absolute path filename. -fileHeaderKey file Header key to use when appending absolute path filename to event header. -basenameHeader false Whether to add a header storing the basename of the file. -basenameHeaderKey basename Header Key to use when appending basename of file to event header. -ignorePattern ^$ Regular expression specifying which files to ignore (skip) -trackerDir .flumespool Directory to store metadata related to processing of files. - If this path is not an absolute path, then it is interpreted as relative to the spoolDir. -consumeOrder oldest In which order files in the spooling directory will be consumed ``oldest``, - ``youngest`` and ``random``. In case of ``oldest`` and ``youngest``, the last modified - time of the files will be used to compare the files. In case of a tie, the file - with smallest lexicographical order will be consumed first. In case of ``random`` any - file will be picked randomly. When using ``oldest`` and ``youngest`` the whole - directory will be scanned to pick the oldest/youngest file, which might be slow if there - are a large number of files, while using ``random`` may cause old files to be consumed - very late if new files keep coming in the spooling directory. -pollDelay 500 Delay (in milliseconds) used when polling for new files. -recursiveDirectorySearch false Whether to monitor sub directories for new files to read. -maxBackoff 4000 The maximum time (in millis) to wait between consecutive attempts to - write to the channel(s) if the channel is full. The source will start at - a low backoff and increase it exponentially each time the channel throws a - ChannelException, upto the value specified by this parameter. -batchSize 100 Granularity at which to batch transfer to the channel -inputCharset UTF-8 Character set used by deserializers that treat the input file as text. -decodeErrorPolicy ``FAIL`` What to do when we see a non-decodable character in the input file. - ``FAIL``: Throw an exception and fail to parse the file. - ``REPLACE``: Replace the unparseable character with the "replacement character" char, - typically Unicode U+FFFD. - ``IGNORE``: Drop the unparseable character sequence. -deserializer ``LINE`` Specify the deserializer used to parse the file into events. - Defaults to parsing each line as an event. The class specified must implement - ``EventDeserializer.Builder``. -deserializer.* Varies per event deserializer. -bufferMaxLines -- (Obselete) This option is now ignored. -bufferMaxLineLength 5000 (Deprecated) Maximum length of a line in the commit buffer. Use deserializer.maxLineLength instead. -selector.type replicating replicating or multiplexing -selector.* Depends on the selector.type value -interceptors -- Space-separated list of interceptors +======================== ============== ========================================================== +Property Name Default Description +======================== ============== ========================================================== +**channels** -- +**type** -- The component type name, needs to be ``spooldir``. +**spoolDir** -- The directory from which to read files from. +fileSuffix .COMPLETED Suffix to append to completely ingested files +deletePolicy never When to delete completed files: ``never`` or ``immediate`` +fileHeader false Whether to add a header storing the absolute path filename. +fileHeaderKey file Header key to use when appending absolute path filename to event header. +basenameHeader false Whether to add a header storing the basename of the file. +basenameHeaderKey basename Header Key to use when appending basename of file to event header. +ignorePattern ^$ Regular expression specifying which files to ignore (skip) +trackerDir .flumespool Directory to store metadata related to processing of files. + If this path is not an absolute path, then it is interpreted as relative to the spoolDir. +consumeOrder oldest In which order files in the spooling directory will be consumed ``oldest``, + ``youngest`` and ``random``. In case of ``oldest`` and ``youngest``, the last modified + time of the files will be used to compare the files. In case of a tie, the file + with smallest lexicographical order will be consumed first. In case of ``random`` any + file will be picked randomly. When using ``oldest`` and ``youngest`` the whole + directory will be scanned to pick the oldest/youngest file, which might be slow if there + are a large number of files, while using ``random`` may cause old files to be consumed + very late if new files keep coming in the spooling directory. +pollDelay 500 Delay (in milliseconds) used when polling for new files. +recursiveDirectorySearch false Whether to monitor sub directories for new files to read. +maxBackoff 4000 The maximum time (in millis) to wait between consecutive attempts to + write to the channel(s) if the channel is full. The source will start at + a low backoff and increase it exponentially each time the channel throws a + ChannelException, upto the value specified by this parameter. +batchSize 100 Granularity at which to batch transfer to the channel +inputCharset UTF-8 Character set used by deserializers that treat the input file as text. +decodeErrorPolicy ``FAIL`` What to do when we see a non-decodable character in the input file. + ``FAIL``: Throw an exception and fail to parse the file. + ``REPLACE``: Replace the unparseable character with the "replacement character" char, + typically Unicode U+FFFD. + ``IGNORE``: Drop the unparseable character sequence. +deserializer ``LINE`` Specify the deserializer used to parse the file into events. + Defaults to parsing each line as an event. The class specified must implement + ``EventDeserializer.Builder``. +deserializer.* Varies per event deserializer. +bufferMaxLines -- (Obselete) This option is now ignored. +bufferMaxLineLength 5000 (Deprecated) Maximum length of a line in the commit buffer. Use deserializer.maxLineLength instead. +selector.type replicating replicating or multiplexing +selector.* Depends on the selector.type value +interceptors -- Space-separated list of interceptors interceptors.* -======================= ============== ========================================================== +======================== ============== ========================================================== Example for an agent named agent-1:
