Uploaded image for project: 'JS - JobScheduler'
  1. JS - JobScheduler
  2. JS-1480

JobScheduler Universal Agent web services

    XMLWordPrintable

Details

    Description

      Desired Behavior

      • The JobScheduler Universal Agent provides status information via following web services
        • /jobscheduler/agent/api general information
        • /jobscheduler/agent/api/overview same as .../api
        • /jobscheduler/agent/api/task running Agent tasks
        • /jobscheduler/agent/api/tunnel Tunnels summary
        • /jobscheduler/agent/api/tunnel/ List of tunnels
        • /jobscheduler/agent/api/command Running command summary
        • /jobscheduler/agent/api/command/ List of running commands (watching file_order_source)
      • The web services can return the media types application/json and text/plain (which is currently returned as YAML).
        If the client accepts both with same priority, the server chooses text over JSON.

      Stable parts

      • All interfaces used by JobScheduler (engine), so that Agent v1.11 should be compatible with JobScheduler v1.10 and vice versa.
      • URIs as above

      The web services response's content could change in future releases. With v1.11, we will stabilize the important parts.

      Examples

      Response for /jobscheduler/agent/api
      totalTaskCount: 0
      isTerminating: false
      system:
        hostname: docker-agent
        mxBeans:
          operatingSystem:
            processCpuLoad: 9.71859949958501E-7
            availableProcessors: 8
            freePhysicalMemorySize: 1791545344
            systemCpuLoad: 0.00774040220626055
            committedVirtualMemorySize: 4809150464
            totalPhysicalMemorySize: 4897579008
      currentTaskCount: 0
      java:
        systemProperties:
          java.vendor: Azul Systems, Inc.
          os.arch: amd64
          os.version: 3.10.0-229.7.2.el7.x86_64
          os.name: Linux
          java.version: 1.8.0_25
      version: 1.10.0-xx
      startedAt: '2015-08-19T15:21:42.423Z'
      
      Response for /jobscheduler/agent/api/task - Running Agent tasks
      tasks:
      - id: 4-259101459
        tunnelId: '4'
        controllerAddress: 127.0.0.1:9338
        startedAt: '2015-08-19T13:11:18.239Z'
      - id: 2-15899022
        tunnelId: '2'
        controllerAddress: 127.0.0.1:9338
        startedAt: '2015-08-19T13:11:18.239Z'
      - id: 3-707059672
        tunnelId: '3'
        controllerAddress: 127.0.0.1:9338
        startedAt: '2015-08-19T13:11:18.239Z'
      
      Response for /jobscheduler/agent/tunnel - Tunnels summary
      tcpAddress: /127.0.0.1:9338
      tunnelCount: 3
      
      Response for /jobscheduler/agent/tunnel/ - List of tunnels
      - id: '2'
        remoteTcpAddress: 127.0.0.1:9359
        statistics:
          requestCount: 35
          messageByteCount: 2492
          currentRequestIssuedAt: '2015-08-19T15:26:18.996Z'
      - id: '4'
        remoteTcpAddress: 127.0.0.1:9357
        statistics:
          requestCount: 35
          messageByteCount: 2492
          currentRequestIssuedAt: '2015-08-19T15:26:18.990Z'
      - id: '3'
        remoteTcpAddress: 127.0.0.1:9358
        statistics:
          requestCount: 35
          messageByteCount: 2492
          currentRequestIssuedAt: '2015-08-19T15:26:18.983Z'
      
      Response for /jobscheduler/agent/command
      totalCommandCount: 145
      currentCommandCount: 1
      
      Response for /jobscheduler/agent/command/ - shows active command for file_order_source
      - internalId: '145'
        startedAt: '2015-08-19T15:25:26.830Z'
        command:
          regex: MATCHING-
          duration: 60.0
          knownFiles:
          - '1'
          - c:\xxxx\file-orders\MATCHING-FILE
          $TYPE: RequestFileOrderSourceContent
          directory: c:/xxxx/file-orders/
      

      Attachments

        Issue Links

          Activity

            People

              jz Joacim Zschimmer
              al Andreas Liebert (Inactive)
              Santiago Aucejo Petzoldt Santiago Aucejo Petzoldt
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: