Retrieve the node status summary

GET api/nodes/status_summary

Retrieves a summary of the monitoring status of all of the nodes and servers in your environment. Rather than returning the details of each individual node, the response returns the number of nodes and servers reporting each kind of monitoring data.

This action is primarily used to troubleshoot monitoring data. Comparing the counts returned for each data source against the total count shows how many nodes and servers are reporting monitoring data, and how many aren't. A large unknown count, or a source total that falls well short of the environment total, indicates that monitoring data isn't reaching the SC//Reliant™ Platform Manager (RPM) from some portion of the fleet.

The response reports counts from two monitoring data sources:

bubbles: the keepalive status checks. Keepalive signals are periodic heartbeat messages sent from each node to RPM, and they determine the status bubbles displayed for each node in the RPM and AcuVigil™ user interfaces.
elastic: the service check status forwarded from the Sensu servers to Elasticsearch. This count reflects how many nodes are successfully forwarding their monitoring check results into Elasticsearch.

Request syntax

get api/nodes/status_summary

Request parameters

The request accepts no parameters.

Response syntax

{
  "nodes": {
    "bubbles": {
      "online": integer,
      "offline": integer,
      "unknown": integer
    },
    "elastic": {
      "online": integer,
      "offline": integer,
      "unknown": integer
    },
    "total": integer
  },
  "servers": {
    "bubbles": {
      "online": integer,
      "offline": integer,
      "unknown": integer
    },
    "total": integer
  }
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Field	Type	Description
`nodes`	Object	The monitoring status summary for the nodes in your environment.
`nodes.bubbles`	Object	The number of nodes in each keepalive status. These are the statuses shown as the node status bubbles in the RPM and AcuVigil™ user interfaces.
`nodes.elastic`	Object	The number of nodes in each status according to the service check data forwarded from the Sensu servers to Elasticsearch.
`nodes.total`	Integer	The total number of nodes in your environment.
`servers`	Object	The monitoring status summary for the servers in your environment.
`servers.bubbles`	Object	The number of servers in each keepalive status.
`servers.total`	Integer	The total number of servers in your environment.
`online`	Integer	The number of nodes or servers reporting monitoring data for the data source.
`offline`	Integer	The number of nodes or servers that the data source reports as offline.
`unknown`	Integer	The number of nodes or servers for which the data source has no status. A node is counted here when no monitoring data has been received from it, so this count is the starting point when troubleshooting missing monitoring data.

Errors

The following are common errors returned by this API.

Code	Message	Cause
-	-	-

Examples

Example: Retrieve the monitoring status summary for all nodes and servers

This example returns the monitoring status summary for every node and server in the environment. In the response, the bubbles and elastic counts for the nodes match, which shows that every node reporting keepalive data is also forwarding its service check results to Elasticsearch.

ruby api.rb <customer_code> get api/nodes/status_summary

Response

{
  "nodes": {
    "bubbles": {
      "online": 1086,
      "offline": 26,
      "unknown": 46
    },
    "elastic": {
      "online": 1086,
      "offline": 26,
      "unknown": 46
    },
    "total": 1158
  },
  "servers": {
    "bubbles": {
      "online": 2030,
      "offline": 30,
      "unknown": 48
    },
    "total": 2108
  }
}