2021-05-05 13:09:47 -04:00
|
|
|
---
|
|
|
|
layout: default
|
|
|
|
title: API
|
|
|
|
parent: Root Cause Analysis
|
|
|
|
grand_parent: Performance Analyzer
|
|
|
|
nav_order: 1
|
2023-02-06 12:48:25 -05:00
|
|
|
redirect_from:
|
|
|
|
- /monitoring-plugins/pa/rca/api/
|
2021-05-05 13:09:47 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
# RCA API
|
|
|
|
|
2023-02-20 11:34:20 -05:00
|
|
|
## Example request
|
2021-05-05 13:09:47 -04:00
|
|
|
|
|
|
|
```
|
|
|
|
# Request all available RCAs
|
2021-05-25 14:18:35 -04:00
|
|
|
GET localhost:9600/_plugins/_performanceanalyzer/rca
|
2021-05-05 13:09:47 -04:00
|
|
|
|
|
|
|
# Request a specific RCA
|
2021-05-25 14:18:35 -04:00
|
|
|
GET localhost:9600/_plugins/_performanceanalyzer/rca?name=HighHeapUsageClusterRca
|
2021-05-05 13:09:47 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
2023-02-20 11:34:20 -05:00
|
|
|
## Example response
|
2021-05-05 13:09:47 -04:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"HighHeapUsageClusterRca": [{
|
|
|
|
"rca_name": "HighHeapUsageClusterRca",
|
|
|
|
"state": "unhealthy",
|
|
|
|
"timestamp": 1587426650942,
|
|
|
|
"HotClusterSummary": [{
|
|
|
|
"number_of_nodes": 2,
|
|
|
|
"number_of_unhealthy_nodes": 1,
|
|
|
|
"HotNodeSummary": [{
|
|
|
|
"host_address": "192.168.144.2",
|
|
|
|
"node_id": "JtlEoRowSI6iNpzpjlbp_Q",
|
|
|
|
"HotResourceSummary": [{
|
|
|
|
"resource_type": "old gen",
|
|
|
|
"threshold": 0.65,
|
|
|
|
"value": 0.81827232588145373,
|
|
|
|
"avg": NaN,
|
|
|
|
"max": NaN,
|
|
|
|
"min": NaN,
|
|
|
|
"unit_type": "heap usage in percentage",
|
|
|
|
"time_period_seconds": 600,
|
|
|
|
"TopConsumerSummary": [{
|
|
|
|
"name": "CACHE_FIELDDATA_SIZE",
|
|
|
|
"value": 590702564
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"name": "CACHE_REQUEST_SIZE",
|
|
|
|
"value": 28375
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"name": "CACHE_QUERY_SIZE",
|
|
|
|
"value": 12687
|
|
|
|
}
|
|
|
|
],
|
|
|
|
}]
|
|
|
|
}]
|
|
|
|
}]
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
```
|