Details

    • Type: Sub-task Sub-task
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.5.0
    • Component/s: Data Collection
    • Labels:
      None
    • Release Note:
      REST API for the Agent. Supports CRUD operations for Adaptors, as well as Adaptor data flow statistics.

      Description

      Develop a REST interface for the Agent to expose Adaptor CRUD operations.

      • Request URI:
        GET /rest/v1/adaptor HTTP/1.0
        
      • For now I'm shooting for the XML and plain text response, but ultimately we can support optional params:
        viewType=[json|xml|text] (default is XML?)
        

      I'm planning on using Jetty similar to how the collector does. We could have some common code that delegates requests to different handlers based on the URI. The current telnet interface will remain as-is.

      1. CHUKWA-515-4.patch
        49 kB
        Bill Graham
      2. CHUKWA-515-3.patch
        53 kB
        Bill Graham
      3. CHUKWA-515-2.patch
        52 kB
        Bill Graham
      4. CHUKWA-515-1.patch
        51 kB
        Bill Graham

        Activity

        Bill Graham created issue -
        Bill Graham made changes -
        Field Original Value New Value
        Assignee Bill Graham [ billgraham ]
        Bill Graham made changes -
        Summary Statistics REST API for Agent REST API for Agent
        Description Develop a REST interface to expose Agent statistics.

        * Request URI:
        {noformat}
        GET /rest/v1/adaptorStats HTTP/1.0
        {noformat}

        * For now I'm shooting for the XML response, but ultimately we can support optional params:
        {noformat}
        viewType=[json|xml|text] (default is XML?)
        {noformat}

        * Response XML

        TBD. My thought is to integrate with the {{AgentMetrics}} and {{ChunkQueueMetrics}} and show their information, along with a list of adaptors. It appears that the same {{MemQueue}} is shared amongst all adaptors, so we won't be able to expose per-adaptor stats as is. Let me know if I'm missing something there, or if you have comments in general about the approach.

        I was planning on using Jetty similar to how the collector does. We could have some common code that delegates requests to different handlers based on the URI. The current telnet interface will remain as-is.
        Develop a REST interface for the Agent to expose Adaptor CRUD operations.

        * Request URI:
        {noformat}
        GET /rest/v1/adaptor HTTP/1.0
        {noformat}

        * For now I'm shooting for the XML and plain text response, but ultimately we can support optional params:
        {noformat}
        viewType=[json|xml|text] (default is XML?)
        {noformat}

        I'm planning on using Jetty similar to how the collector does. We could have some common code that delegates requests to different handlers based on the URI. The current telnet interface will remain as-is.
        Component/s data collection [ 12312723 ]
        Bill Graham made changes -
        Attachment CHUKWA-515-1.patch [ 12453812 ]
        Bill Graham made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Release Note REST API for the Agent. Supports CRUD operations for Adaptors, as well as Adaptor data flow statistics.
        Bill Graham made changes -
        Attachment CHUKWA-515-2.patch [ 12454042 ]
        Bill Graham made changes -
        Attachment CHUKWA-515-3.patch [ 12454393 ]
        Bill Graham made changes -
        Status Patch Available [ 10002 ] Open [ 1 ]
        Bill Graham made changes -
        Attachment CHUKWA-515-4.patch [ 12454558 ]
        Bill Graham made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Fix Version/s 0.5.0 [ 12315030 ]
        Bill Graham made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]

          People

          • Assignee:
            Bill Graham
            Reporter:
            Bill Graham
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development