Kibana endpoints
/kibana/clusters/metrics
Returns Kibana KPI metrics.
GET http://unravel-host:3000/api/v1/kibana/clusters/metrics?start_time=(date}&end_time={date}
None.
Name | Type | Description |
|---|---|---|
| string | Start date for report. Format: YYYY-MM-DD |
| string | End date for report. Format: YYYY-MM-DD |
Name | Type | Description |
|---|---|---|
| ms | Time period between data sampling for metrics. |
| int | Total number of concurrent connections to Kibana instance. |
| string | Date and time the metrics were last updated. Format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'" |
| string | Load average over 15 minutes |
| string | Load average over 1 minutes |
| bytes | Available heap memory. |
| bytes | Total heap memory. |
| bytes | Used heap memory. |
| ms | OS uptime in milliseconds. |
| bytes | Limit of memory usage before garbage collection. |
| bytes | Total heap memory available for Kibana instance. |
| bytes | Total heap memory used by Kibana instance. |
| ms | Process uptime in milliseconds. |
| int | Number of disconnected client requests. |
| int | Total number of client requests received by Kibana instance. |
| int | Maximum time taken to respond to client requests received by the Kibana instance. |
| string | Name of the Kibana instance. |
| string | Overall Kibana status since the specified time. Format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'" |
| string | Overall status of the Kibana instance. |
| string | Title of the Kibana status. |
| bytes/sec | Total heap used per metric collection interval. |
Request:
curl -X GET "http://node.mycompany.com:3000/api/v1/kibana/clusters/metrics?start_time=2020-01-01&end_time=2020-04-01" -H "accept: application/json" -H "Authorization: JWT JWT tokenResponse body:
{
"kibana": {
"metrics_collection_interval_in_millis": 5000,
"metrics_concurrent_connections": 2,
"metrics_last_updated": "2020-04-03T10:10:23.822Z",
"metrics_os_load_15m": "-",
"metrics_os_load_1m": "-",
"metrics_os_memory_free_in_bytes": 1028771840,
"metrics_os_memory_total_in_bytes": "-",
"metrics_os_memory_used_in_bytes": "-",
"metrics_os_uptime_in_millis": "-",
"metrics_process_memory_heap_size_limit": 1526909922,
"metrics_process_memory_heap_total_in_bytes": 196923392,
"metrics_process_memory_heap_used_in_bytes": 152856592,
"metrics_process_uptime_in_millis": 1123753,
"metrics_requests_disconnects": 0,
"metrics_requests_total": 0,
"metrics_response_times_max_in_millis": 0,
"name": "node.mycompany.com",
"status_overall_since": "2020-04-03T09:52:42.188Z",
"status_overall_state": "green",
"status_overall_title": "Green",
"heap_rate": "-"
}
}/kibana/{cluster}/kpi_cluster
Returns cluster level metric values of Kibana.
GET http://unravel-host:3000/api/v1/kibana/{cluster}/kpi_cluster?start_time={date}&end_time={date}&prefix={metrics}
Name | Type | Description |
|---|---|---|
| string | Cluster name. |
Name | Type | Description |
|---|---|---|
| string | Start date for report. Format: YYYY-MM-DD |
| string | End date for report. Format: YYYY-MM-DD |
| CSL | Add any of the following metrics: metrics_process_memory_heap_used_in_bytes metrics_requests_total metrics_requests_disconnects metrics_concurrent_connections |
Name | Type | Description | ||
|---|---|---|---|---|
kibana | array |
| ||
| int | Time (epoch time stamp). | ||
| int | Value of the metric in the given timestamp. | ||
Request:
curl -X GET "http://localhost:8081/api/v1/kibana/kibana/kpi_cluster?start_time=2020-01-01&end_time=2020-04-04&prefix=metrics_process_memory_heap_used_in_bytes" -H "accept: application/json" -H "Authorization: JWT tokenResponse:
{
"kibana": [
{
"ts": 1585904400000,
"avg_vd": 158250770
},
{
"ts": 1585908000000,
"avg_vd": 159986282.52631578
}
]