Repository: flume Updated Branches: refs/heads/trunk 591b13832 -> fca8c5b97
FLUME-2998. Add a missing configuration parameter to SequenceSource docs SequenceSource's totalEvents is configurable, but it is not in the documentation. This patch fixes that problem by adding the missing configuration parameter to the docs. Reviewers: Denes Arvay, Bessenyei Balázs Donát (Attila Simon via Bessenyei Balázs Donát) Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/fca8c5b9 Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/fca8c5b9 Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/fca8c5b9 Branch: refs/heads/trunk Commit: fca8c5b970cf0bbae61bae08f2084dd4f3bd1143 Parents: 591b138 Author: Attila Simon <[email protected]> Authored: Fri Sep 30 12:01:12 2016 +0200 Committer: Bessenyei Balázs Donát <[email protected]> Committed: Fri Sep 30 12:01:12 2016 +0200 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeUserGuide.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/fca8c5b9/flume-ng-doc/sphinx/FlumeUserGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst b/flume-ng-doc/sphinx/FlumeUserGuide.rst index 0fecee6..ab71d38 100644 --- a/flume-ng-doc/sphinx/FlumeUserGuide.rst +++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst @@ -1352,21 +1352,22 @@ Example for agent named a1: Sequence Generator Source ~~~~~~~~~~~~~~~~~~~~~~~~~ -A simple sequence generator that continuously generates events with a counter -that starts from 0 and increments by 1. Useful mainly for testing. -Required properties are in **bold**. +A simple sequence generator that continuously generates events with a counter that starts from 0, +increments by 1 and stops at totalEvents. Retries when it can't send events to the channel. Useful +mainly for testing. Required properties are in **bold**. -============== =========== ======================================== -Property Name Default Description -============== =========== ======================================== +============== =============== ======================================== +Property Name Default Description +============== =============== ======================================== **channels** -- -**type** -- The component type name, needs to be ``seq`` -selector.type replicating or multiplexing -selector.* replicating Depends on the selector.type value -interceptors -- Space-separated list of interceptors +**type** -- The component type name, needs to be ``seq`` +selector.type replicating or multiplexing +selector.* replicating Depends on the selector.type value +interceptors -- Space-separated list of interceptors interceptors.* batchSize 1 -============== =========== ======================================== +totalEvents Long.MAX_VALUE Number of unique events sent by the source. +============== =============== ======================================== Example for agent named a1:
