Zhijie Shen commented on YARN-3539:

Steve, thanks for updating the patch. The new one looks good to me overall. 
However, I'm afraid there's syntax error in {{TimelineServer.md}}. {{mvn site}} 
will faile here.

One thing I found with the document is that we give timeline server the 
abbreviation ATS. The story is that the project begins from monitoring 
application information, and therefore we named it application timeline server 
originally. However, we can see its scope can go beyond application actually, 
such as monitoring system metrics too. Hence we try to avoid the application 
prefix, and call it (YARN) timeline server. Though we still often refer to ATS 
in our discussions/comments for shot, I suggest not declaring it officially in 
the documentation. Thoughts?

There're some other nits:

1. there's a dollar sign here.
GET http://<timeline server http address:port>/ws/v1/timeline/${entity-type}

2. The output example of the following query is not formatted.
GET http://<timeline server http 

3. You can remove all {{?user.name=zshen}}, which is security related param.

4. Elements of the app (Application) Object's table is still not formatted 

5. The format around the follow text seems not be correct.
GET http://localhost:8188/ws/v1/timeline/domain?user.name=zshen

ISSUE: this example uses user.name to identify the owner; the 2.7.x 
implementation, TimelineWebServices uses owner

> Compatibility doc to state that ATS v1 is a stable REST API
> -----------------------------------------------------------
>                 Key: YARN-3539
>                 URL: https://issues.apache.org/jira/browse/YARN-3539
>             Project: Hadoop YARN
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 2.7.0
>            Reporter: Steve Loughran
>            Assignee: Steve Loughran
>              Labels: BB2015-05-TBR
>         Attachments: HADOOP-11826-001.patch, HADOOP-11826-002.patch, 
> YARN-3539-003.patch, YARN-3539-004.patch, YARN-3539-005.patch, 
> YARN-3539-006.patch, YARN-3539-007.patch, timeline_get_api_examples.txt
> The ATS v2 discussion and YARN-2423 have raised the question: "how stable are 
> the ATSv1 APIs"?
> The existing compatibility document actually states that the History Server 
> is [a stable REST 
> API|http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Compatibility.html#REST_APIs],
>  which effectively means that ATSv1 has already been declared as a stable API.
> Clarify this by patching the compatibility document appropriately

This message was sent by Atlassian JIRA

Reply via email to