[jira] [Commented] (YARN-6159) In timeline v2 documentation, the code snippet given for creating timeline client has a mistake

["Hadoop QA (JIRA)" <ji...@apache.org>]

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

Hadoop QA commented on YARN-6159:
---------------------------------

| (/) *{color:green}+1 overall{color}* |
\\
\\
|| Vote || Subsystem || Runtime || Comment ||
| {color:blue}0{color} | {color:blue} reexec {color} | {color:blue}  0m 12s{color} | {color:blue} Docker mode activated. {color} |
| {color:green}+1{color} | {color:green} @author {color} | {color:green}  0m  0s{color} | {color:green} The patch does not contain any @author tags. {color} |
| {color:green}+1{color} | {color:green} mvninstall {color} | {color:green} 12m 33s{color} | {color:green} trunk passed {color} |
| {color:green}+1{color} | {color:green} mvnsite {color} | {color:green}  0m 15s{color} | {color:green} trunk passed {color} |
| {color:green}+1{color} | {color:green} mvnsite {color} | {color:green}  0m 12s{color} | {color:green} the patch passed {color} |
| {color:green}+1{color} | {color:green} whitespace {color} | {color:green}  0m  0s{color} | {color:green} The patch has no whitespace issues. {color} |
| {color:green}+1{color} | {color:green} asflicense {color} | {color:green}  0m 15s{color} | {color:green} The patch does not generate ASF License warnings. {color} |
| {color:black}{color} | {color:black} {color} | {color:black} 13m 51s{color} | {color:black} {color} |
\\
\\
|| Subsystem || Report/Notes ||
| Docker |  Image:yetus/hadoop:a9ad5d6 |
| JIRA Issue | YARN-6159 |
| JIRA Patch URL | https://issues.apache.org/jira/secure/attachment/12852392/YARN-6159.v1.001.patch |
| Optional Tests |  asflicense  mvnsite  |
| uname | Linux 53d0d0c0fe65 3.13.0-105-generic #152-Ubuntu SMP Fri Dec 2 15:37:11 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux |
| Build tool | maven |
| Personality | /testptch/hadoop/patchprocess/precommit/personality/provided.sh |
| git revision | trunk / cc45da7 |
| modules | C: hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site U: hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site |
| Console output | https://builds.apache.org/job/PreCommit-YARN-Build/14909/console |
| Powered by | Apache Yetus 0.5.0-SNAPSHOT   http://yetus.apache.org |


This message was automatically generated.



> In timeline v2 documentation, the code snippet given for creating timeline client has a mistake
> -----------------------------------------------------------------------------------------------
>
>                 Key: YARN-6159
>                 URL: https://issues.apache.org/jira/browse/YARN-6159
>             Project: Hadoop YARN
>          Issue Type: Bug
>          Components: documentation
>            Reporter: Varun Saxena
>            Assignee: Naganarasimha G R
>            Priority: Trivial
>         Attachments: YARN-6159.v1.001.patch
>
>
> In TimelineServiceV2.md, under section Publishing application specific data, we have the following code snippet. Here, {{timelineClient.putEntitiesAsync(entity);}} should be {{client.putEntitiesAsync(entity);}} instead.
> {code}
>     // Create and start the Timeline client v.2
>     TimelineClient client = TimelineClient.createTimelineClient(appId);
>     client.init(conf);
>     client.start();
>     try {
>       TimelineEntity myEntity = new TimelineEntity();
>       myEntity.setEntityType("MY_APPLICATION");
>       myEntity.setEntityId("MyApp1")
>       // Compose other entity info
>       // Blocking write
>       client.putEntities(entity);
>       TimelineEntity myEntity2 = new TimelineEntity();
>       // Compose other info
>       // Non-blocking write
>       timelineClient.putEntitiesAsync(entity);
>     } catch (IOException e) {
>       // Handle the exception
>     } catch (RuntimeException e) {
> {code}
> Below can also be changed to client to keep it consistent.
> {code}
>     amRMClient.registerTimelineClient(timelineClient);
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org