hadoop-yarn-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Varun Saxena (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (YARN-3814) REST API implementation for getting raw entities in TimelineReader
Date Wed, 15 Jul 2015 19:58:06 GMT

    [ https://issues.apache.org/jira/browse/YARN-3814?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14628623#comment-14628623
] 

Varun Saxena commented on YARN-3814:
------------------------------------

+*For Get Entities API,*+

appId and entityType are mandatory parameters for querying multiple entities hence they are
kept as part of path in REST URL.
Optional query Parameters for get entity API have been kept as *clusterId, userId, flowId,
flowRunId, limit, createdTimeStart, createdTimeEnd, modifiedTimeStart, modifiedTimeEnd, relatesTo,
isRelatedTo,  infofilters, conffilters, metricfilters, eventfilters and fields.*

Behavior of userId, flowId, flowRunId, fields and clusterId is same as it is for get entity
API.

*createdTimeStart and createdTimeEnd* specifies the time window in which created time for
entity should fall for it to be returned. This specifies seconds since epoch and is represented
as a long internally. Either start or end can be specified. 

*modifiedTimeStart and modifiedTimeEnd* specifies the time window in which modified time for
entity should fall for it to be returned. This specifies seconds since epoch and is represented
as a long internally.

*limit* specifies how many entities have to be returned in response. If number of entities
is more than the limit, most recent entities are returned i.e. sorted descendingly by created
time.

*relatesTo and isRelatedTo* directy map to these fields in TimelineEntity. These are specified
as a comma separated list. With type to IDs' given in the form :
{noformat}
[type]:[id1];[id2];[id3]

For instance, 
relatesTo=type1:id1;id2,type2:id1
This means the entity returned should match with relatesTo field having id1 and id2 of type1
& id1 of type2.
{noformat}

*infoFilters and configFilters* specifies the configs or info (with their values) which should
match with entities to be returned. They are in the form of key value pair. Value part of
config filters is deciphered as a String. For info filters, no such restriction exists. Key
value pairs are specified as under :
{noformat}
[key]:[value]
So, infofilters=info1:val1,info2:val2 means entities which have info1 with val1 and info2
with val2 should be returned.
{noformat}

*metricFilters and eventFilters* are both a comma separated list of metric IDs' and events
which should match.

> REST API implementation for getting raw entities in TimelineReader
> ------------------------------------------------------------------
>
>                 Key: YARN-3814
>                 URL: https://issues.apache.org/jira/browse/YARN-3814
>             Project: Hadoop YARN
>          Issue Type: Sub-task
>          Components: timelineserver
>    Affects Versions: YARN-2928
>            Reporter: Varun Saxena
>            Assignee: Varun Saxena
>         Attachments: YARN-3814-YARN-2928.01.patch
>
>




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message