[
https://issues.apache.org/jira/browse/YARN-5052?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15318776#comment-15318776
]
Joep Rottinghuis commented on YARN-5052:
----------------------------------------
Hi Varun, thanks for the patch. Here are a few comments. I jotted the comments
down as I noticed them in reading, some of the patterns repeat in multiple
sections. There may be a couple of comments outside of what you just modified,
but I guess we can adjust them all the same:
Item 6 infofilter, describe "ene" existent but not equal.
"Only configs matching either of the prefixes will be retrieved."
"Only configs matching any of the prefixes will be retrieved."
either implies there are only two choices.
On any of the lists, is an empty list acceptable?
In query parameters instead of using negative wording:
" If specified, matched applications should not have been created before this
timestamp."
If specified, then only application created after this timestamp are returned".
Not clear what it means when we write:
"entity types should not exist" I think we mean to write "those entity types
will not be returned".
If we want to use the wording "matched applications" to indicate that we return
only matches,
that is fine, we should not use the word "should" that appears to imply that we
are not sure.
Hey this should not happen (but somehow it did). Instead we should say "will
not".
In items 11 confsToRetrieve we say this very cleanly and clearly:
"Only configs matching either of the prefixes will be retrieved.".
After "Brackets are optional" instead of
"Or, it can be can be an expression of the form :"
simply make it:
"Brackets are optional for the simple expression. Alternatively, expressions
can be of the form:"
This wording is similar in other queries.
In some places we document:
"For all other errors while retrieving data, HTTP 500 (Internal Server Error)
is returned."
In fact that isn't true in current implementation. There are several errors
that we
swallow and ignore. I don't know if we opened a jira to address this, but this
was discussed in on of the comment threads.
We may want to say something like HTT% 500 (Internal Server Error) is returned
for non-recoverable errors or something like that.
In Queryapp we have a single word "alongwith", should be two words.
In query app:
"flowname Flow name which should match for the application."
should be
"flowname Flow return applications only for this flow."
I'm not sure that I understand this part:
"Part of flow context information and if specified alongwith
flowrunid and userid, we would not need to fetch flow context information while
executing this query."
I can't quite suggest different wording, because it isn't clear what we're
trying to say here.
Under Query Generic Entities:
"If number of matching entities are more than the
limit, most recent entities till the limit is reached, will be returned."
->
"If number of matching entities are more than the
limit, the most recent entities up to the limit will be returned."
> Update timeline service v2 documentation to capture information about filters
> -----------------------------------------------------------------------------
>
> Key: YARN-5052
> URL: https://issues.apache.org/jira/browse/YARN-5052
> Project: Hadoop YARN
> Issue Type: Sub-task
> Components: timelineserver
> Affects Versions: YARN-2928
> Reporter: Varun Saxena
> Assignee: Varun Saxena
> Labels: yarn-2928-1st-milestone
> Attachments: Apache Hadoop 3.0.0-SNAPSHOT – The YARN Timeline Service
> v.pdf, YARN-5052-YARN-2928.01.patch
>
>
> Since YARN-4447 has gone in, we can update our documentation to capture
> information about usage of filters.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
