Author: stevel
Date: Mon Feb 2 16:29:25 2015
New Revision: 1656511
URL: http://svn.apache.org/r1656511
Log:
SLIDER-768 update the REST API with liveness
Modified:
incubator/slider/site/trunk/content/docs/api/slider_REST_api_v2.md
Modified: incubator/slider/site/trunk/content/docs/api/slider_REST_api_v2.md
URL:
http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/api/slider_REST_api_v2.md?rev=1656511&r1=1656510&r2=1656511&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/api/slider_REST_api_v2.md
(original)
+++ incubator/slider/site/trunk/content/docs/api/slider_REST_api_v2.md Mon Feb
2 16:29:25 2015
@@ -462,20 +462,20 @@ All of these are GET operations on data
<td>list of components and summary data</td>
</tr>
<tr>
- <td>live/components/{name}</td>
+ <td>live/components/{component}</td>
<td>Info on a specific component, including list of containers</td>
</tr>
<tr>
- <td>live/components/{name}/instances/{index}</td>
+ <td>live/components/{component}/instances/{index}</td>
<td>Index of containers; map to contents of container ID.</td>
</tr>
<tr>
- <td>live/components/{name}/containers/</td>
- <td>List of container IDs</td>
+ <td>live/components/{component}/containers/</td>
+ <td>List of container IDs for a named component type</td>
</tr>
<tr>
- <td>live/components/{name}/containers/{container_id}
-</td>
+ <td>live/components/{component}/containers/{container_id}
+ </td>
<td>ContainerInfo</td>
</tr>
<tr>
@@ -484,9 +484,18 @@ All of these are GET operations on data
</tr>
<tr>
<td>live/nodes/${nodeid}</td>
- <td>Node info on a node (e.g containers)</td>
+ <td>Node info on a node (e.g history containers)</td>
</tr>
<tr>
+ <td>live/liveness</td>
+ <td>aggregate liveness information</td>
+ </tr>
+ <tr>
+ <td>live/liveness/{component}</td>
+ <td>Liveness information for a named component type</td>
+ </tr>
+
+ <tr>
<td>live/statistics</td>
<td>General statistics</td>
</tr>
@@ -494,6 +503,8 @@ All of these are GET operations on data
All live values will be cached and refreshed regularly; the caching ensures
that a heavy load of GET operations does not overload the application master.
+It does mean that there may be a delay of under a second
+before an updated value is visible.
# Actions
@@ -558,3 +569,31 @@ The contents of application/live/resourc
}
+
+## `live/liveness`
+
+The liveness URL returns a JSON structure on the liveness of the
+application as perceived by Slider itself.
+
+See `org.apache.slider.api.types.ApplicationLivenessInformation`
+
+ {
+ "allRequestsSatisfied": true,
+ "requestsOutstanding": 0
+ }
+
+
+Its initial/basic form counts the number of outstanding container requests.
+
+This could be extended in future with more criteria, such as the minimum
number/
+percentage of desired containers of each component type have been allocated
+âor even how many were actually running.
+
+Any new liveness probes will supplement rather than replace the current values.
+
+## To be defined: `live/statisticts`
+
+The statistics will cover the collected statistics on a component type, as well
+as aggregate statistics on an application instance.
+
+When an Application Master is restarted, all statistics will be lost.
\ No newline at end of file
