[YARN-5577] [Atsv2] Document object passing in infofilters with an example

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha2, YARN-5355_branch2
• Component/s: timelinereader, timelineserver
• Labels: documentation
• Hadoop Flags: Reviewed
• Assignee: Rohith Sharma K S
• Reporter: Rohith Sharma K S
• Created: 29/Aug/16 07:24
• Updated: 30/Aug/17 12:50
• Resolved: 19/Sep/16 09:05

Description

In HierarchicalTimelineEntity, setparent/addChild allows to set parent/child entities at INFO level. The key is an string and value as an object.
Like below, for YARN_CONTAINER entity parent entity set for application.

"SYSTEM_INFO_PARENT_ENTITY": {
       "type": "YARN_APPLICATION",
       "id": "application_1471931266232_0024"
     }

But to use infofilter on entity type YARN_CONTAINER for an specific applicationId, IIUC there is no way to pass object as value in infofilter.

To make easier retrieval either

1. publish parent/child entity id and type as string rather that object like below

   "SYSTEM_INFO_PARENT_ENTITY_TYPE": "YARN_APPLICATION"
   "SYSTEM_INFO_PARENT_ENTITY_ID":"application_1471931266232_0024"
   

   OR

2. Add ability to provide object as filter with below format like infofilters=SYSTEM_INFO_PARENT_ENTITY eq ((type eq YARN_APPLICATION) AND (id eq application_1471931266232_0024))

I believe 2nd approach will be well applicable for any entities. But I am not sure does HBase supports such a custom filters while scanning a table.

1st approaches will be much easier to change.