You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2015/07/11 00:08:45 UTC

samza git commit: SAMZA-709: added monitoring page for REST API and the dashboard

Repository: samza
Updated Branches:
  refs/heads/master d5fbe1b96 -> 94e37ecb7


SAMZA-709: added monitoring page for REST API and the dashboard


Project: http://git-wip-us.apache.org/repos/asf/samza/repo
Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/94e37ecb
Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/94e37ecb
Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/94e37ecb

Branch: refs/heads/master
Commit: 94e37ecb7cbbe2c69d7a54b89b64905b965300a7
Parents: d5fbe1b
Author: Aleksandar Bircakovic <a....@levi9.com>
Authored: Fri Jul 10 15:08:15 2015 -0700
Committer: Yan Fang <ya...@gmail.com>
Committed: Fri Jul 10 15:08:15 2015 -0700

----------------------------------------------------------------------
 .../documentation/yarn/samza-am-dashboard.png   | Bin 55603 -> 126597 bytes
 docs/learn/documentation/versioned/index.html   |   1 +
 .../versioned/jobs/reprocessing.md              |   2 +-
 .../versioned/jobs/web-ui-rest-api.md           |  62 +++++++++++++++++++
 4 files changed, 64 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/samza/blob/94e37ecb/docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png
----------------------------------------------------------------------
diff --git a/docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png b/docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png
index 949a2f0..3ce3acf 100644
Binary files a/docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png and b/docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png differ

http://git-wip-us.apache.org/repos/asf/samza/blob/94e37ecb/docs/learn/documentation/versioned/index.html
----------------------------------------------------------------------
diff --git a/docs/learn/documentation/versioned/index.html b/docs/learn/documentation/versioned/index.html
index e1b9f2d..85209bd 100644
--- a/docs/learn/documentation/versioned/index.html
+++ b/docs/learn/documentation/versioned/index.html
@@ -72,6 +72,7 @@ title: Documentation
   <li><a href="jobs/yarn-jobs.html">YARN Jobs</a></li>
   <li><a href="jobs/logging.html">Logging</a></li>
   <li><a href="jobs/reprocessing.html">Reprocessing</a></li>
+  <li><a href="jobs/web-ui-rest-api.html">Web UI and REST API</a></li>
 </ul>
 
 <h4>YARN</h4>

http://git-wip-us.apache.org/repos/asf/samza/blob/94e37ecb/docs/learn/documentation/versioned/jobs/reprocessing.md
----------------------------------------------------------------------
diff --git a/docs/learn/documentation/versioned/jobs/reprocessing.md b/docs/learn/documentation/versioned/jobs/reprocessing.md
index 28d9925..174b46f 100644
--- a/docs/learn/documentation/versioned/jobs/reprocessing.md
+++ b/docs/learn/documentation/versioned/jobs/reprocessing.md
@@ -80,4 +80,4 @@ If you are taking the *parallel rewind* approach described above, running two jo
 
 Samza gives you a lot of flexibility for reprocessing historical data, and you don't need to program against a separate batch processing API to take advantage of it. If you're mindful of these issues, you can build a data system that is very robust, but still gives you lots of freedom to change your processing logic in future.
 
-## [Application Master &raquo;](../yarn/application-master.html)
+## [Web UI and REST API &raquo;](web-ui-rest-api.html)

http://git-wip-us.apache.org/repos/asf/samza/blob/94e37ecb/docs/learn/documentation/versioned/jobs/web-ui-rest-api.md
----------------------------------------------------------------------
diff --git a/docs/learn/documentation/versioned/jobs/web-ui-rest-api.md b/docs/learn/documentation/versioned/jobs/web-ui-rest-api.md
new file mode 100644
index 0000000..8449403
--- /dev/null
+++ b/docs/learn/documentation/versioned/jobs/web-ui-rest-api.md
@@ -0,0 +1,62 @@
+---
+layout: page
+title: Web UI and REST API
+---
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
+### Dashboard
+
+Samza's ApplicationMaster comes with a dashboard to show useful information such as:
+
+1. Where containers are located.
+2. Links to logs.
+3. The Samza job's configuration.
+4. Container failure count.
+
+You can find this dashboard by going to your YARN grid's ResourceManager page (usually something like [http://localhost:8088/cluster](http://localhost:8088/cluster)), and clicking on the "ApplicationMaster" link of a running Samza job.
+
+<img src="/img/{{site.version}}/learn/documentation/yarn/samza-am-dashboard.png" alt="Screenshot of ApplicationMaster dashboard" class="diagram-large">
+
+### REST API
+
+REST API produces JSON and provides information about metrics, task context, config, containers and status.
+
+<table class="table table-condensed table-bordered table-striped">
+  <thead>
+    <tr>
+      <th>Endpoint</th>
+      <th>Meaning</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>/metrics</td><td>HahsMap that represents metrics for every 60 seconds.</td>
+    </tr>
+    <tr>
+      <td>/task-context</td><td>HashMap that provides information about task context including task name and task ID.</td>
+    </tr>
+    <tr>
+      <td>/am</td><td>HashMap that represents information about containers and status.</td>
+    </tr>
+    <tr>
+      <td>/config</td><td>HashMap that represents the config.</td>
+    </tr>
+  </tbody>
+</table>
+
+## [Application Master &raquo;](../yarn/application-master.html)