Apache
/
hadoop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Addendum for YARN-4753. Use doxia macro to generate in-page TOC of YARN site documentation

This commit is contained in:
Varun Saxena 2017-08-30 20:19:48 +05:30
parent 3d5bf1c06d
commit 78a6ecccb3
2 changed files with 45 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hadoop-project/src/site/site.xml
View File

@ -148,7 +148,7 @@
<item name="Resource Manager" href="hadoop-yarn/hadoop-yarn-site/ResourceManagerRest.html"/>
<item name="Node Manager" href="hadoop-yarn/hadoop-yarn-site/NodeManagerRest.html"/>
<item name="Timeline Server" href="hadoop-yarn/hadoop-yarn-site/TimelineServer.html#Timeline_Server_REST_API_v1"/>
<item name="Timeline Service V.2" href="hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_REST_API_v2"/>
<item name="Timeline Service V.2" href="hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_v.2_REST_API"/>
</menu>
<menu name="Hadoop Compatible File Systems" inherit="top">

103
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServiceV2.md
View File

@ -15,25 +15,9 @@
The YARN Timeline Service v.2
========================
* [Overview](#Overview)
* [Introduction](#Introduction)
* [Architecture](#Architecture)
* [Current Status](#Current_Status)
* [Deployment](#Deployment)
* [Configurations](#Configurations)
* [Enabling Timeline Service v.2](#Enabling_Timeline_Service_v2)
* [Publishing of application specific data](#Publishing_of_application_specific_data)
* [Timeline Service v.2 REST API](#Timeline_Service_REST_API_v2)
* [Query Flows](#REST_API_LIST_FLOWS)
* [Query Flow Runs](#REST_API_LIST_FLOW_RUNS)
* [Query Flow Run](#REST_API_LIST_FLOW_RUN)
* [Query Apps for a Flow](#REST_API_LIST_FLOW_APPS)
* [Query Apps for a Flow Run](#REST_API_LIST_FLOWRUN_APPS)
* [Query App](#REST_API_LIST_APP)
* [Query Generic Entities](#REST_API_LIST_ENTITIES)
* [Query Generic Entity](#REST_API_LIST_ENTITY)
<!-- MACRO{toc|fromDepth=0|toDepth=2} -->
#<a name="Overview"></a>Overview
## <a name="Overview"></a>Overview
### <a name="Introduction"></a>Introduction
@ -127,9 +111,9 @@ analysis
* Migration and compatibility with v.1
#<a name="Deployment"></a>Deployment
## <a name="Deployment"></a>Deployment
###<a name="Configurations"></a>Configurations
### <a name="Configurations"></a>Configurations
New configuration parameters that are introduced with v.2 are marked bold.
@ -365,6 +349,7 @@ To write MapReduce framework data to Timeline Service v.2, enable the following
<value>true</value>
</property>
```
### Upgrade from alpha1 to alpha2
If you are currently running Timeline Service v2 alpha1 version, we recommend the following:
@ -499,7 +484,7 @@ You can provide the flow context via YARN application tags:
appContext.setApplicationTags(tags);
# <a name="Timeline_Service_REST_API_v2"></a>Timeline Service v.2 REST API
## Timeline Service v.2 REST API
Querying Timeline Service v.2 is currently only supported via REST API; there is no API client
implemented in the YARN libraries.
@ -527,14 +512,14 @@ Returns a JSON object describing the service instance and version information.
The following shows the supported queries on the REST API.
## <a name="REST_API_LIST_FLOWS"></a>Query Flows
### <a name="REST_API_LIST_FLOWS"></a>Query Flows
With Query Flows API, you can retrieve a list of active flows that had runs most recently.
If the REST endpoint without the cluster name is used, the cluster specified by the configuration
`yarn.resourcemanager.cluster-id` in `yarn-site.xml` is taken. If none of the flows match the
predicates, an empty list will be returned.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/flows/
@ -542,7 +527,7 @@ predicates, an empty list will be returned.
GET /ws/v2/timeline/flows/
### Query Parameters Supported:
#### Query Parameters Supported:
1. `limit` - If specified, defines the number of flows to return. The maximum possible value for limit
is maximum value of Long. If it is not specified or has a value less than 0, then limit will be
@ -561,7 +546,7 @@ predicates, an empty list will be returned.
1. `fromid` - If specified, retrieve the next set of flows from the given fromid. The set of entities retrieved is inclusive of specified fromid.
fromid should be taken from the value associated with FROM_ID info key in flow entity response which was sent earlier.
### Example JSON Response:
#### Example JSON Response:
[
{
@ -615,14 +600,14 @@ predicates, an empty list will be returned.
}
]
### Response Codes
#### Response Codes
1. If successful, a HTTP 200 (OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
1. For non-recoverable errors while retrieving data, HTTP 500 (Internal Server Error) is returned.
## <a name="REST_API_LIST_FLOW_RUNS"></a>Query Flow Runs
### <a name="REST_API_LIST_FLOW_RUNS"></a>Query Flow Runs
With Query Flow Runs API, you can drill further down to get the runs (specific instances) of a
given flow. This returns the most recent runs that belong to the given flow. If the REST
@ -630,7 +615,7 @@ endpoint without the cluster name is used, the cluster specified by the configur
`yarn.resourcemanager.cluster-id` in `yarn-site.xml` is taken. If none of the flow runs match the
predicates, an empty list will be returned.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/
@ -638,7 +623,7 @@ predicates, an empty list will be returned.
GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/
### Query Parameters Supported:
#### Query Parameters Supported:
1. `limit` - If specified, defines the number of flows to return. The maximum possible value for limit
is maximum value of Long. If it is not specified or has a value less than 0, then limit will be
@ -660,7 +645,7 @@ predicates, an empty list will be returned.
1. `fromid` - If specified, retrieve the next set of flow run entities from the given fromid. The set of entities retrieved is inclusive of specified fromid.
fromid should be taken from the value associated with FROM_ID info key in flow entity response which was sent earlier.
### Example JSON Response:
#### Example JSON Response:
[
{
@ -699,21 +684,21 @@ predicates, an empty list will be returned.
}
]
### Response Codes
#### Response Codes
1. If successful, a HTTP 200 (OK) response is returned.
1. If any problem occurs in parsing request or if an invalid field is specified in fields query param, HTTP 400 (Bad Request) is returned.
1. For non-recoverable errors while retrieving data, HTTP 500 (Internal Server Error) is returned.
## <a name="REST_API_LIST_FLOW_RUN"></a>Query Flow Run
### <a name="REST_API_LIST_FLOW_RUN"></a>Query Flow Run
With this API, you can query a specific flow run identified by cluster, user, flow name and run id.
If the REST endpoint without the cluster name is used, the cluster specified by the configuration
`yarn.resourcemanager.cluster-id` in `yarn-site.xml` is taken. Metrics are returned by default
while querying individual flow runs.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/{run id}
@ -721,7 +706,7 @@ while querying individual flow runs.
GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/{run id}
### Query Parameters Supported:
#### Query Parameters Supported:
1. `metricstoretrieve` - If specified, defines which metrics to retrieve or which ones not to retrieve and send back in response.
metricstoretrieve can be an expression of the form :<br/>
@ -732,7 +717,7 @@ while querying individual flow runs.
This specifies a comma separated list of metric id prefixes. Only metrics not matching any of the prefixes will be retrieved.<br/>
Please note that URL unsafe characters such as spaces will have to be suitably encoded.
### Example JSON Response:
#### Example JSON Response:
{
"metrics": [
@ -769,14 +754,14 @@ while querying individual flow runs.
"relatesto": {}
}
### Response Codes
#### Response Codes
1. If successful, a HTTP 200(OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
1. If flow run for the given flow run id cannot be found, HTTP 404 (Not Found) is returned.
1. For non-recoverable errors while retrieving data, HTTP 500 (Internal Server Error) is returned.
## <a name="REST_API_LIST_FLOW_APPS"></a>Query Apps for a flow
### <a name="REST_API_LIST_FLOW_APPS"></a>Query Apps for a flow
With this API, you can query all the YARN applications that are part of a specific flow. If the
REST endpoint without the cluster name is used, the cluster specified by the configuration
@ -784,7 +769,7 @@ REST endpoint without the cluster name is used, the cluster specified by the con
applications are more than the limit, the most recent apps up to the limit will be returned. If
none of the apps match the predicates, an empty list will be returned.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/apps
@ -792,7 +777,7 @@ none of the apps match the predicates, an empty list will be returned.
GET /ws/v2/timeline/users/{user name}/flows/{flow name}/apps
### Query Parameters Supported:
#### Query Parameters Supported:
1. `limit` - If specified, defines the number of applications to return. The maximum possible value for limit
is maximum value of Long. If it is not specified or has a value less than 0, then limit will be
@ -870,7 +855,7 @@ none of the apps match the predicates, an empty list will be returned.
1. `fromid` - If specified, retrieve the next set of application entities from the given fromid. The set of entities retrieved is inclusive of specified fromid.
fromid should be taken from the value associated with FROM_ID info key in flow entity response which was sent earlier.
### Example JSON Response:
#### Example JSON Response:
[
{
@ -903,13 +888,13 @@ none of the apps match the predicates, an empty list will be returned.
}
]
### Response Codes
#### Response Codes
1. If successful, a HTTP 200 (OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
1. For non-recoverable errors while retrieving data, HTTP 500 (Internal Server Error) is returned.
## <a name="REST_API_LIST_FLOWRUN_APPS"></a>Query Apps for a flow run
### <a name="REST_API_LIST_FLOWRUN_APPS"></a>Query Apps for a flow run
With this API, you can query all the YARN applications that are part of a specific flow run. If the
REST endpoint without the cluster name is used, the cluster specified by the configuration
@ -917,7 +902,7 @@ REST endpoint without the cluster name is used, the cluster specified by the con
are more than the limit, the most recent apps up to the limit will be returned. If none of the apps
match the predicates, an empty list will be returned.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/{run id}/apps
@ -925,7 +910,7 @@ match the predicates, an empty list will be returned.
GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/{run id}/apps/
### Query Parameters Supported:
#### Query Parameters Supported:
1. `limit` - If specified, defines the number of applications to return. The maximum possible value for limit
is maximum value of Long. If it is not specified or has a value less than 0, then limit will be
@ -1003,7 +988,7 @@ match the predicates, an empty list will be returned.
1. `fromid` - If specified, retrieve the next set of application entities from the given fromid. The set of entities retrieved is inclusive of specified fromid.
fromid should be taken from the value associated with FROM_ID info key in flow entity response which was sent earlier.
### Example JSON Response:
#### Example JSON Response:
[
{
@ -1022,14 +1007,14 @@ match the predicates, an empty list will be returned.
}
]
### Response Codes
#### Response Codes
1. If successful, a HTTP 200 (OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
1. For non-recoverable errors while retrieving data, HTTP 500 (Internal Server Error) is returned.
## <a name="REST_API_LIST_APP"></a>Query app
### <a name="REST_API_LIST_APP"></a>Query app
With this API, you can query a single YARN application identified by the cluster and the
application ID. If the REST endpoint without the cluster name is used, the cluster specified by the
@ -1038,7 +1023,7 @@ information i.e. user, flow name and run id are not mandatory but if specified i
preclude the need for an additional operation to fetch flow context information based on cluster
and app id.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}
@ -1046,7 +1031,7 @@ and app id.
GET /ws/v2/timeline/apps/{app id}
### Query Parameters Supported:
#### Query Parameters Supported:
1. `userid` - If specified, only applications belonging to this user will be returned. This query param must be specified along with flowname and flowrunid query params, otherwise it will be ignored.
If userid, flowname and flowrunid are not specified, we would have to fetch flow context information based on cluster and appid while executing the query.
@ -1082,7 +1067,7 @@ and app id.
1. `metricsTimeStart` - If specified, then metrics for the entity after this timestamp are returned.
1. `metricsTimeEnd` - If specified, then metrics for the entity before this timestamp are returned.
### Example JSON Response:
#### Example JSON Response:
{
"metrics": [],
@ -1098,7 +1083,7 @@ and app id.
"relatesto": {}
}
### Response Codes
#### Response Codes
1. If successful, a HTTP 200(OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
@ -1119,7 +1104,7 @@ For instance, we can query containers by specifying entity type as `YARN_CONTAIN
attempts by specifying entity type as `YARN_APPLICATION_ATTEMPT`.
If none of the entities match the predicates, an empty list will be returned.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}/entities/{entity type}
@ -1127,7 +1112,7 @@ If none of the entities match the predicates, an empty list will be returned.
GET /ws/v2/timeline/apps/{app id}/entities/{entity type}
### Query Parameters Supported:
#### Query Parameters Supported:
1. `userid` - If specified, only entities belonging to this user will be returned. This query param must be specified along with flowname and flowrunid query params, otherwise it will be ignored.
If userid, flowname and flowrunid are not specified, we would have to fetch flow context information based on cluster and appid while executing the query.
@ -1210,7 +1195,7 @@ If none of the entities match the predicates, an empty list will be returned.
1. `fromid` - If specified, retrieve the next set of generic entities from the given fromid. The set of entities retrieved is inclusive of specified fromid.
fromid should be taken from the value associated with FROM_ID info key in flow entity response which was sent earlier.
### Example JSON Response:
#### Example JSON Response:
[
{
@ -1243,7 +1228,7 @@ If none of the entities match the predicates, an empty list will be returned.
}
]
### Response Codes
#### Response Codes
1. If successful, a HTTP 200(OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.
@ -1398,7 +1383,7 @@ a specific YARN container by specifying entity type as `YARN_CONTAINER` and givi
container ID. Similarly, application attempt can be queried by specifying entity type as
`YARN_APPLICATION_ATTEMPT` and entity ID being the application attempt ID.
### HTTP request:
#### HTTP request:
GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}/entities/{entity type}/{entity id}
@ -1406,7 +1391,7 @@ container ID. Similarly, application attempt can be queried by specifying entity
GET /ws/v2/timeline/apps/{app id}/entities/{entity type}/{entity id}
### Query Parameters Supported:
#### Query Parameters Supported:
1. `userid` - If specified, entity must belong to this user. This query param must be specified along with flowname and flowrunid query params, otherwise it will be ignored.
If userid, flowname and flowrunid are not specified, we would have to fetch flow context information based on cluster and appid while executing the query.
@ -1443,7 +1428,7 @@ container ID. Similarly, application attempt can be queried by specifying entity
1. `metricsTimeEnd` - If specified, then metrics for the entity before this timestamp are returned.
1. `entityidprefix` Defines the id prefix for the entity to be fetched. If specified, then entity retrieval will be faster.
### Example JSON Response:
#### Example JSON Response:
{
"metrics": [ ],
@ -1460,7 +1445,7 @@ container ID. Similarly, application attempt can be queried by specifying entity
"relatesto": { }
}
### Response Codes
#### Response Codes
1. If successful, a HTTP 200 (OK) response is returned.
1. If any problem occurs in parsing request, HTTP 400 (Bad Request) is returned.