Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.4.0, 0.5.0, 0.6.0
    • Fix Version/s: 0.6.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      It would be useful to document and show usage of Chukwa Agent REST API.

      1. agent-rest.html
        10 kB
        Eric Yang
      2. CHUKWA-718.2.patch
        97 kB
        Eric Yang
      3. CHUKWA-718.3.patch
        1 kB
        Eric Yang
      4. CHUKWA-718.patch
        106 kB
        Eric Yang

        Activity

        Hide
        eyang Eric Yang added a comment -

        Add ability to generate REST API document based on javadoc annotation.
        Some correction to agent REST API also made this non-backward compatible. I have increased the REST API version to v2 to ensure usage of the API is validated for integration. The self generating document should help to keep document and code in sync for going forward.

        Show
        eyang Eric Yang added a comment - Add ability to generate REST API document based on javadoc annotation. Some correction to agent REST API also made this non-backward compatible. I have increased the REST API version to v2 to ensure usage of the API is validated for integration. The self generating document should help to keep document and code in sync for going forward.
        Hide
        eyang Eric Yang added a comment -

        Sample of the generated REST API document.

        Show
        eyang Eric Yang added a comment - Sample of the generated REST API document.
        Hide
        eyang Eric Yang added a comment -

        Update schema license file, and update test case configuration.

        Show
        eyang Eric Yang added a comment - Update schema license file, and update test case configuration.
        Hide
        eyang Eric Yang added a comment -

        I just committed this.

        Show
        eyang Eric Yang added a comment - I just committed this.
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Chukwa-trunk #498 (See https://builds.apache.org/job/Chukwa-trunk/498/)
        CHUKWA-718. Updated Chukwa Agent REST API document and generation method. (Eric Yang) (eyang: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1611856)

        • /chukwa/trunk/CHANGES.txt
        • /chukwa/trunk/pom.xml
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorAveragedRate.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorConfig.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorInfo.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorList.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/ContextProvider.java
        • /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/Examples.java
        • /chukwa/trunk/src/main/resources
        • /chukwa/trunk/src/main/resources/agent-rest.xml
        • /chukwa/trunk/src/main/resources/application-grammars.xml
        • /chukwa/trunk/src/main/webapps
        • /chukwa/trunk/src/main/webapps/wadl.xsl
        • /chukwa/trunk/src/site/site.xml
        • /chukwa/trunk/src/test/java/org/apache/hadoop/chukwa/datacollection/adaptor/TestAddAdaptor.java
        • /chukwa/trunk/src/test/java/org/apache/hadoop/chukwa/datacollection/agent/rest/TestAdaptorController.java
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Chukwa-trunk #498 (See https://builds.apache.org/job/Chukwa-trunk/498/ ) CHUKWA-718 . Updated Chukwa Agent REST API document and generation method. (Eric Yang) (eyang: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1611856 ) /chukwa/trunk/CHANGES.txt /chukwa/trunk/pom.xml /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorAveragedRate.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorConfig.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorInfo.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorList.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/ContextProvider.java /chukwa/trunk/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/Examples.java /chukwa/trunk/src/main/resources /chukwa/trunk/src/main/resources/agent-rest.xml /chukwa/trunk/src/main/resources/application-grammars.xml /chukwa/trunk/src/main/webapps /chukwa/trunk/src/main/webapps/wadl.xsl /chukwa/trunk/src/site/site.xml /chukwa/trunk/src/test/java/org/apache/hadoop/chukwa/datacollection/adaptor/TestAddAdaptor.java /chukwa/trunk/src/test/java/org/apache/hadoop/chukwa/datacollection/agent/rest/TestAdaptorController.java
        Hide
        eyang Eric Yang added a comment -

        com/sun/jersey/contribs/maven-wadl-plugin depends on maven 2.0.9, which does not exist on public maven repositories. This is causing Jenkins to fail the build.

        Show
        eyang Eric Yang added a comment - com/sun/jersey/contribs/maven-wadl-plugin depends on maven 2.0.9, which does not exist on public maven repositories. This is causing Jenkins to fail the build.
        Hide
        eyang Eric Yang added a comment -

        Updated dependencies to exclude maven 2.0.9.

        Show
        eyang Eric Yang added a comment - Updated dependencies to exclude maven 2.0.9.
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Chukwa-trunk #504 (See https://builds.apache.org/job/Chukwa-trunk/504/)
        CHUKWA-718. Updated Chukwa Agent REST API document and generation method. (Eric Yang) (eyang: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1611932)

        • /chukwa/trunk/pom.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Chukwa-trunk #504 (See https://builds.apache.org/job/Chukwa-trunk/504/ ) CHUKWA-718 . Updated Chukwa Agent REST API document and generation method. (Eric Yang) (eyang: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1611932 ) /chukwa/trunk/pom.xml

          People

          • Assignee:
            eyang Eric Yang
            Reporter:
            eyang Eric Yang
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development