Repository: flume Updated Branches: refs/heads/trunk 35de8ff18 -> a73b67853
FLUME-1521. Document the StressSource (Ashish Paliwal via Roshan Naik) Project: http://git-wip-us.apache.org/repos/asf/flume/repo Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/a73b6785 Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/a73b6785 Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/a73b6785 Branch: refs/heads/trunk Commit: a73b6785332a55eeb82f4a915e09cee305714959 Parents: 35de8ff Author: Roshan Naik <[email protected]> Authored: Wed Nov 19 19:24:48 2014 -0800 Committer: Roshan Naik <[email protected]> Committed: Wed Nov 19 19:36:01 2014 -0800 ---------------------------------------------------------------------- flume-ng-doc/sphinx/FlumeUserGuide.rst | 31 +++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flume/blob/a73b6785/flume-ng-doc/sphinx/FlumeUserGuide.rst ---------------------------------------------------------------------- diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst b/flume-ng-doc/sphinx/FlumeUserGuide.rst index b9a8329..0199d62 100644 --- a/flume-ng-doc/sphinx/FlumeUserGuide.rst +++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst @@ -1433,6 +1433,37 @@ Property Name Default Description handler.maxBlobLength 100000000 The maximum number of bytes to read and buffer for a given request ===================== ================== ============================================================================ +Stress Source +~~~~~~~~~~~~~ + +StressSource is an internal load-generating source implementation which is very useful for +stress tests. It allows User to configure the size of Event payload, with empty headers. +User can configure total number of events to be sent as well maximum number of Successful +Event to be delivered. + +Required properties are in **bold**. + +=================== =========== =================================================== +Property Name Default Description +=================== =========== =================================================== +**type** -- The component type name, needs to be ``org.apache.flume.source.StressSource`` +size 500 Payload size of each Event. Unit:**byte** +maxTotalEvents -1 Maximum number of Events to be sent +maxSuccessfulEvents -1 Maximum number of Events successfully sent +batchSize 1 Number of Events to be sent in one batch +=================== =========== =================================================== + +Example for agent named **a1**: + +.. code-block:: properties + + a1.sources = stresssource-1 + a1.channels = memoryChannel-1 + a1.sources.stresssource-1.type = org.apache.flume.source.StressSource + a1.sources.stresssource-1.size = 10240 + a1.sources.stresssource-1.maxTotalEvents = 1000000 + a1.sources.stresssource-1.channels = memoryChannel-1 + Legacy Sources ~~~~~~~~~~~~~~
