[
https://issues.apache.org/jira/browse/YARN-3150?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15249075#comment-15249075
]
Li Lu commented on YARN-3150:
-----------------------------
Thanks for the work [~sjlee0]! Several notes when I was reading the doc:
- For the list of timeline v2 configs, maybe we'd like to distinguish the
configs that we adopt from existing ATS v1.x configs and the newly introduced
configs? We may want to stress the overridden configs.
- Maybe we'd like to have a few more sentences about the timeline schema
creator? There are some "hidden" functions that might be interesting.
- We may want to clarify the meaning of "system metrics" and "container
metrics" in the document. When readers have some v1 background, it may be
helpful to distinguish a few wordings in the document: "system metrics" vs.
"application history data" in AHS, "container metrics" vs. the old "public
container metrics" option in v1.
- We may want to explicitly mention in the "Publishing application specific
data" section that this section is mainly for YARN application programmers, but
not for cluster operators.
- Note the programmers that the return value of v2 APIs are changed to void?
- Maybe we can be more precise about the "reasonable defaults" for flow
contexts?
- We need separate docs for the REST APIs in the future. Right now the REST API
doc is just a simple reference.
> [Documentation] Documenting the timeline service v2
> ---------------------------------------------------
>
> Key: YARN-3150
> URL: https://issues.apache.org/jira/browse/YARN-3150
> Project: Hadoop YARN
> Issue Type: Sub-task
> Reporter: Zhijie Shen
> Assignee: Sangjin Lee
> Labels: yarn-2928-1st-milestone
> Attachments: TimelineServiceV2.html, YARN-3150-YARN-2928.01.patch
>
>
> Let's make sure we will have a document to describe what's new in TS v2, the
> APIs, the client libs and so on. We should do better around documentation in
> v2 than v1.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
