Home

Kibana endpoints
/kibana/clusters/metrics

Returns Kibana KPI metrics.

Request
GET http://unravel-host:3000/api/v1/kibana/clusters/metrics?start_time=(date}&end_time={date} 
Path parameters

None.

Query parameters

Name

Type

Description

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

Response body

Name

Type

Description

metrics_collection_interval_in_millis

ms

Time period between data sampling for metrics.

metrics_concurrent_connections

int

Total number of concurrent connections to Kibana instance.

metrics_last_updated

string

Date and time the metrics were last updated.

Format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'"

metrics_os_load_15m

string

Load average over 15 minutes

metrics_os_load_1m

string

Load average over 1 minutes

metrics_os_memory_free_in_bytes

bytes

Available heap memory.

metrics_os_memory_total_in_bytes

bytes

Total heap memory.

metrics_os_memory_used_in_bytes

bytes

Used heap memory.

metrics_os_uptime_in_millis

ms

OS uptime in milliseconds.

metrics_process_memory_heap_size_limit

bytes

Limit of memory usage before garbage collection.

metrics_process_memory_heap_total_in_bytes

bytes

Total heap memory available for Kibana instance.

metrics_process_memory_heap_used_in_bytes

bytes

Total heap memory used by Kibana instance.

metrics_process_uptime_in_millis

ms

Process uptime in milliseconds.

metrics_requests_disconnects

int

Number of disconnected client requests.

metrics_requests_total

int

Total number of client requests received by Kibana instance.

metrics_response_times_max_in_millis

int

Maximum time taken to respond to client requests received by the Kibana instance.

name

string

Name of the Kibana instance.

status_overall_since

string

Overall Kibana status since the specified time.

Format: YYYY-MM-DD'T'HH:mm:ss.SSS'Z'"

status_overall_state

string

Overall status of the Kibana instance.

status_overall_title

string

Title of the Kibana status.

heap_rate

bytes/sec

Total heap used per metric collection interval.

Examples

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 token

Response 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.

Request
GET http://unravel-host:3000/api/v1/kibana/{cluster}/kpi_cluster?start_time={date}&end_time={date}&prefix={metrics} 
Path parameters

Name

Type

Description

cluster

string

Cluster name.

Query parameters

Name

Type

Description

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

prefix

CSL

Add any of the following metrics:

metrics_process_memory_heap_used_in_bytes

metrics_requests_total

metrics_requests_disconnects

metrics_concurrent_connections

Response body

Name

Type

Description

kibana

array

 

ts

int

Time (epoch time stamp).

avg_vd

int

Value of the metric in the given timestamp.

Example

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  token

Response:

{
  "kibana": [
    {
      "ts": 1585904400000,
      "avg_vd": 158250770
    },
    {
     "ts": 1585908000000,
     "avg_vd": 159986282.52631578
    }
  ]