forked from apache/samza
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SAMZA-709: added monitoring page for REST API and the dashboard
- Loading branch information
1 parent
d5fbe1b
commit 94e37ec
Showing
4 changed files
with
64 additions
and
1 deletion.
There are no files selected for viewing
Binary file modified
BIN
+69.3 KB
(230%)
docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
62 changes: 62 additions & 0 deletions
62
docs/learn/documentation/versioned/jobs/web-ui-rest-api.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 »](../yarn/application-master.html) |