Uploaded image for project: 'Puppet Server'
  1. Puppet Server
  2. SERVER-1505

Document initial status service endpoint

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Normal
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: SERVER 2.6.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Sub-team:
    • Story Points:
      1
    • Sprint:
      Server Emerald 2016-09-07
    • Release Notes:
      Not Needed
    • Release Notes Summary:

      Description

      In SERVER-1502, the trapperkeeper-status service was included in the Puppet Server service bundle. Ahead of the 2.6.0 release, we should provide some documentation about the status service.

      Requests made to the status service will initially only include info for the status-service itself, for example:

      {
          "status-service": {
              "detail_level": "debug",
              "service_status_version": 1,
              "service_version": "0.3.5",
              "state": "running",
              "status": {
                  "experimental": {
                      "jvm-metrics": {
                          "heap-memory": {
                              "committed": 1049100288,
                              "init": 268435456,
                              "max": 1908932608,
                              "used": 216512656
                          },
                          "non-heap-memory": {
                              "committed": 256466944,
                              "init": 2555904,
                              "max": -1,
                              "used": 173201432
                          },
                          "start-time-ms": 1472496731281,
                          "up-time-ms": 538974
                      }
                  }
              }
          }
      }
      

      It may be valuable to do an additional JSON schema just reflecting the elements currently being exposed.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned
              Reporter:
              jeremy.barlow Jeremy Barlow
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support