flume-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From roshann...@apache.org
Subject flume git commit: FLUME-2558. Update javadoc for StressSource
Date Wed, 26 Nov 2014 05:04:29 GMT
Repository: flume
Updated Branches:
  refs/heads/flume-1.6 5600b70a0 -> c829d84b0


FLUME-2558. Update javadoc for 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/c829d84b
Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/c829d84b
Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/c829d84b

Branch: refs/heads/flume-1.6
Commit: c829d84b0fa63d63578be8aed157ac2e6b08ab06
Parents: 5600b70
Author: Roshan Naik <roshan@hortonworks.com>
Authored: Tue Nov 25 21:00:11 2014 -0800
Committer: Roshan Naik <roshan@hortonworks.com>
Committed: Tue Nov 25 21:00:11 2014 -0800

----------------------------------------------------------------------
 .../org/apache/flume/source/StressSource.java   | 25 +++++++++++++++-----
 1 file changed, 19 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flume/blob/c829d84b/flume-ng-core/src/main/java/org/apache/flume/source/StressSource.java
----------------------------------------------------------------------
diff --git a/flume-ng-core/src/main/java/org/apache/flume/source/StressSource.java b/flume-ng-core/src/main/java/org/apache/flume/source/StressSource.java
index 562b983..0e7020b 100644
--- a/flume-ng-core/src/main/java/org/apache/flume/source/StressSource.java
+++ b/flume-ng-core/src/main/java/org/apache/flume/source/StressSource.java
@@ -35,7 +35,21 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Internal load-generating source implementation. Useful for tests.
+ * 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
+ * Events to be delivered. Useful for tests
+ *
+ * Example configuration for Agent a1
+ * <PRE>
+ *   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
+ * </PRE>
  *
  * See {@link StressSource#configure(Context)} for configuration options.
  */
@@ -57,15 +71,14 @@ public class StressSource extends AbstractSource implements
 
   public StressSource() {
     counterGroup = new CounterGroup();
-
   }
 
   /**
    * Read parameters from context
-   * <li>-maxTotalEvents = type long that defines the total number of events to be
sent
-   * <li>-maxSuccessfulEvents = type long that defines the total number of events to
be sent
-   * <li>-size = type int that defines the number of bytes in each event
-   * <li>-batchSize = type int that defines the number of events being sent in one
batch
+   * <li>-maxTotalEvents = type long that defines the total number of Events to be
sent
+   * <li>-maxSuccessfulEvents = type long that defines the number of successful Events
+   * <li>-size = type int that defines the number of bytes in each Event
+   * <li>-batchSize = type int that defines the number of Events being sent in one
batch
    */
   @Override
   public void configure(Context context) {


Mime
View raw message