This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

RCA API

Example request

  1. # Request all available RCAs
  2. GET localhost:9600/_plugins/_performanceanalyzer/rca
  4. # Request a specific RCA
  5. GET localhost:9600/_plugins/_performanceanalyzer/rca?name=HighHeapUsageClusterRca

Example response

  1. {
  2.   "HighHeapUsageClusterRca": [{
  3.     "rca_name": "HighHeapUsageClusterRca",
  4.     "state": "unhealthy",
  5.     "timestamp": 1587426650942,
  6.     "HotClusterSummary": [{
  7.       "number_of_nodes": 2,
  8.       "number_of_unhealthy_nodes": 1,
  9.       "HotNodeSummary": [{
  10.         "host_address": "192.168.144.2",
  11.         "node_id": "JtlEoRowSI6iNpzpjlbp_Q",
  12.         "HotResourceSummary": [{
  13.           "resource_type": "old gen",
  14.           "threshold": 0.65,
  15.           "value": 0.81827232588145373,
  16.           "avg": NaN,
  17.           "max": NaN,
  18.           "min": NaN,
  19.           "unit_type": "heap usage in percentage",
  20.           "time_period_seconds": 600,
  21.           "TopConsumerSummary": [{
  22.               "name": "CACHE_FIELDDATA_SIZE",
  23.               "value": 590702564
  24.             },
  25.             {
  26.               "name": "CACHE_REQUEST_SIZE",
  27.               "value": 28375
  28.             },
  29.             {
  30.               "name": "CACHE_QUERY_SIZE",
  31.               "value": 12687
  32.             }
  33.           ],
  34.         }]
  35.       }]
  36.     }]
  37.   }]
  38. }