apex-malhar git commit: APEXMALHAR-2433 #resolve #comment Add readme for Windowing Benchmark closes #573

[th...@apache.org]

Repository: apex-malhar
Updated Branches:
  refs/heads/master d45e8369c -> 2b3c2aa88


APEXMALHAR-2433 #resolve #comment Add readme for Windowing Benchmark
closes #573


Project: http://git-wip-us.apache.org/repos/asf/apex-malhar/repo
Commit: http://git-wip-us.apache.org/repos/asf/apex-malhar/commit/2b3c2aa8
Tree: http://git-wip-us.apache.org/repos/asf/apex-malhar/tree/2b3c2aa8
Diff: http://git-wip-us.apache.org/repos/asf/apex-malhar/diff/2b3c2aa8

Branch: refs/heads/master
Commit: 2b3c2aa8884fa946dc25c91e17577e3ac6e7964b
Parents: d45e836
Author: brightchen <br...@datatorrent.com>
Authored: Mon Mar 6 13:33:51 2017 -0800
Committer: Thomas Weise <th...@apache.org>
Committed: Mon Mar 20 17:16:15 2017 -0700

----------------------------------------------------------------------
 .../com/datatorrent/benchmark/window/README.md  | 32 ++++++++++++++++++++
 1 file changed, 32 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/2b3c2aa8/benchmark/src/main/java/com/datatorrent/benchmark/window/README.md
----------------------------------------------------------------------
diff --git a/benchmark/src/main/java/com/datatorrent/benchmark/window/README.md b/benchmark/src/main/java/com/datatorrent/benchmark/window/README.md
new file mode 100644
index 0000000..604b43b
--- /dev/null
+++ b/benchmark/src/main/java/com/datatorrent/benchmark/window/README.md
@@ -0,0 +1,32 @@
+Windowed Operator Benchmark Readme
+
+Introduction
+The Windowed operator benchmark are applications to test the performance of windowed operator. 
+This benchmark applications only available for Malhar 3.7.0 or later versions. 
+The source code is located inside the malhar/benchmark. There are two applications, 
+one is benchmark for WindowedOperator, another is for KeyedWindowedOperator. 
+
+Steps of compile
+- Get source code of malhar
+- Compile the malhar with all module option "-Pall-modules": "mvn clean install -Pall-modules -DskipTests"
+
+Run the benchmark and check the result in cluster
+- Start apex cli
+- Launch application "WindowedOperatorBenchmarkApp" or "KeyedWindowedOperatorBenchmarkApp". Get application id, for example "application_1487803614053_10401"
+- Use command "connect" to connect to the application
+- Use command "list-operators" to list operators of the application
+- Find the operator with name "output". Get the value of "host" field. for example "node1:8041"
+- Go to the resource manager and click "Nodes" link in the left panel
+- Find the node by "Node Address" which run the operator "output", click the link of "Node HTTP Address" column. for example "node1:8042"
+- Expand the "Tools" on the left panel and click "Local logs"
+- Click the "container/" link
+- Select the application folder. The folder name is same as the application id
+- Click the container and then click the log file 
+- Open the log. you will find the benchmark which log in the log file for example: 
+  "total: count: 7356000; time: 278453; average: 26417; period: count: 400000; time: 10005; average: 39980"
+  Each log of benchmark includes \u201ctotal\u201d section and \u201cperiod\u201d section. 
+  Total section counts all time from application started to log time. 
+  "period" counts the time from previous log time to current log time. 
+- The period average can help to determine if the rate is stable or not. The total average suppose to trends to the period average if application is stable
+  The valid rate should be the stable rate
+- Suggest to run this application several times to eliminate any temporary interference by environment.