Uploaded image for project: 'Hadoop YARN'
  1. Hadoop YARN
  2. YARN-5843

Incorrect documentation for timeline service entityType/events REST end points

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.9.0, 3.0.0-alpha2
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      http(s)://<timeline server http(s) address:port>/ws/v1/timeline/

      {entityType}

      /events

      entityIds - The entity IDs to retrieve events for.
      limit - A limit on the number of events to return for each entity. If null, defaults to 100 events per entity.
      windowStart - If not null, retrieves only events later than the given time (exclusive)
      windowEnd - If not null, retrieves only events earlier than the given time (inclusive)
      eventTypes - Restricts the events returned to the given types. If null, events of all types will be returned.
      

      parameter should be
      entityId
      eventType
      Mention comma separated entityId and entitytype for multiple arguments

      1. YARN-5843.0002.patch
        3 kB
        Bibin A Chundatt
      2. YARN-5843.0001.patch
        2 kB
        Bibin A Chundatt

        Activity

        Hide
        varun_saxena Varun Saxena added a comment -

        Thanks Bibin A Chundatt for raising the issue.

        This should be fixed. Additionally we can mention that entityId is a mandatory query parameter because without it no events will be returned.

        Show
        varun_saxena Varun Saxena added a comment - Thanks Bibin A Chundatt for raising the issue. This should be fixed. Additionally we can mention that entityId is a mandatory query parameter because without it no events will be returned.
        Hide
        bibinchundatt Bibin A Chundatt added a comment -

        Attaching patch after handling

        1. Comments from Varun Saxena
        2. Field parameter correction
        3. Example correction of events
        Show
        bibinchundatt Bibin A Chundatt added a comment - Attaching patch after handling Comments from Varun Saxena Field parameter correction Example correction of events
        Hide
        hadoopqa Hadoop QA added a comment -
        +1 overall



        Vote Subsystem Runtime Comment
        0 reexec 0m 16s Docker mode activated.
        +1 @author 0m 0s The patch does not contain any @author tags.
        +1 mvninstall 6m 59s trunk passed
        +1 mvnsite 0m 14s trunk passed
        +1 mvnsite 0m 10s the patch passed
        +1 whitespace 0m 0s The patch has no whitespace issues.
        +1 asflicense 0m 17s The patch does not generate ASF License warnings.
        8m 17s



        Subsystem Report/Notes
        Docker Image:yetus/hadoop:e809691
        JIRA Issue YARN-5843
        JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12837803/YARN-5843.0001.patch
        Optional Tests asflicense mvnsite
        uname Linux 68fb147484d3 3.13.0-95-generic #142-Ubuntu SMP Fri Aug 12 17:00:09 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux
        Build tool maven
        Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
        git revision trunk / acd509d
        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/13808/console
        Powered by Apache Yetus 0.4.0-SNAPSHOT http://yetus.apache.org

        This message was automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall Vote Subsystem Runtime Comment 0 reexec 0m 16s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. +1 mvninstall 6m 59s trunk passed +1 mvnsite 0m 14s trunk passed +1 mvnsite 0m 10s the patch passed +1 whitespace 0m 0s The patch has no whitespace issues. +1 asflicense 0m 17s The patch does not generate ASF License warnings. 8m 17s Subsystem Report/Notes Docker Image:yetus/hadoop:e809691 JIRA Issue YARN-5843 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12837803/YARN-5843.0001.patch Optional Tests asflicense mvnsite uname Linux 68fb147484d3 3.13.0-95-generic #142-Ubuntu SMP Fri Aug 12 17:00:09 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / acd509d 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/13808/console Powered by Apache Yetus 0.4.0-SNAPSHOT http://yetus.apache.org This message was automatically generated.
        Hide
        varun_saxena Varun Saxena added a comment -

        Thanks Bibin A Chundatt for the patch.
        Few comments.

        1. In Response Body section, there should be no URL. We can put the real URL in HTTP Request section because this is an example.
        2. Not directly related to JIRA raised but under Timeline Entity List section, "HTTP Operations Supported" should be only GET and not GET followed by URL. Also the URL under the section HTTP Operations Supported can be put under JSON response - > HTTP Request section.
        3. Under Timeline Entity section, the URL in Response Body should be moved to HTTP Request section.
        4. Couple of nits in your patch. There should be a space between full stop and next sentence under the section "Query Parameters Supported".
        Show
        varun_saxena Varun Saxena added a comment - Thanks Bibin A Chundatt for the patch. Few comments. In Response Body section, there should be no URL. We can put the real URL in HTTP Request section because this is an example. Not directly related to JIRA raised but under Timeline Entity List section, "HTTP Operations Supported" should be only GET and not GET followed by URL. Also the URL under the section HTTP Operations Supported can be put under JSON response - > HTTP Request section. Under Timeline Entity section, the URL in Response Body should be moved to HTTP Request section. Couple of nits in your patch. There should be a space between full stop and next sentence under the section "Query Parameters Supported".
        Hide
        bibinchundatt Bibin A Chundatt added a comment -

        Thank you Varun Saxena for comments.
        Updating patch handling all comments

        Show
        bibinchundatt Bibin A Chundatt added a comment - Thank you Varun Saxena for comments. Updating patch handling all comments
        Hide
        hadoopqa Hadoop QA added a comment -
        +1 overall



        Vote Subsystem Runtime Comment
        0 reexec 0m 17s Docker mode activated.
        +1 @author 0m 0s The patch does not contain any @author tags.
        +1 mvninstall 7m 13s trunk passed
        +1 mvnsite 0m 14s trunk passed
        +1 mvnsite 0m 10s the patch passed
        +1 whitespace 0m 0s The patch has no whitespace issues.
        +1 asflicense 0m 15s The patch does not generate ASF License warnings.
        8m 31s



        Subsystem Report/Notes
        Docker Image:yetus/hadoop:e809691
        JIRA Issue YARN-5843
        JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12837973/YARN-5843.0002.patch
        Optional Tests asflicense mvnsite
        uname Linux 6cf6962fe4cf 3.13.0-95-generic #142-Ubuntu SMP Fri Aug 12 17:00:09 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux
        Build tool maven
        Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
        git revision trunk / 026b39a
        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/13824/console
        Powered by Apache Yetus 0.4.0-SNAPSHOT http://yetus.apache.org

        This message was automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall Vote Subsystem Runtime Comment 0 reexec 0m 17s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. +1 mvninstall 7m 13s trunk passed +1 mvnsite 0m 14s trunk passed +1 mvnsite 0m 10s the patch passed +1 whitespace 0m 0s The patch has no whitespace issues. +1 asflicense 0m 15s The patch does not generate ASF License warnings. 8m 31s Subsystem Report/Notes Docker Image:yetus/hadoop:e809691 JIRA Issue YARN-5843 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12837973/YARN-5843.0002.patch Optional Tests asflicense mvnsite uname Linux 6cf6962fe4cf 3.13.0-95-generic #142-Ubuntu SMP Fri Aug 12 17:00:09 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / 026b39a 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/13824/console Powered by Apache Yetus 0.4.0-SNAPSHOT http://yetus.apache.org This message was automatically generated.
        Hide
        varun_saxena Varun Saxena added a comment -

        +1.
        Will commit it later today unless there are further comments.

        Show
        varun_saxena Varun Saxena added a comment - +1. Will commit it later today unless there are further comments.
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Jenkins build Hadoop-trunk-Commit #10810 (See https://builds.apache.org/job/Hadoop-trunk-Commit/10810/)
        YARN-5843. Incorrect documentation for timeline service (varunsaxena: rev c8bc7a84758f360849b96c2e19c8c41b7e9dbb65)

        • (edit) hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Jenkins build Hadoop-trunk-Commit #10810 (See https://builds.apache.org/job/Hadoop-trunk-Commit/10810/ ) YARN-5843 . Incorrect documentation for timeline service (varunsaxena: rev c8bc7a84758f360849b96c2e19c8c41b7e9dbb65) (edit) hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
        Hide
        varun_saxena Varun Saxena added a comment -

        Committed to trunk, branch-2.
        Thanks Bibin A Chundatt for your contribution.

        Show
        varun_saxena Varun Saxena added a comment - Committed to trunk, branch-2. Thanks Bibin A Chundatt for your contribution.

          People

          • Assignee:
            bibinchundatt Bibin A Chundatt
            Reporter:
            bibinchundatt Bibin A Chundatt
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development