Home

/elasticsearch/{cluster}/kpi_node

Returns the metric values of specific nodes

Request
GET http://unravel-host:8081/api/v1/elasticsearch/{cluster}/kpi_node?start_time={date}&end_time={date}&prefix={metrics}&node={node}
Path Parameters

Name

Type

Description

{cluster}

string

Name of the cluster.

Query Parameters

Name

Type

Description

{cluster}

string

cluster name

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

node

string

Node name.

prefix

string

Any of the following metrics:

  • jvm_mem_heap_used_in_byte

  • indices_segments_memory_in_bytes

  • os_cpu_percent

  • heap_percent

  • Indices_segments_count

  • search_latency

  • indexing_latency

  • indices_docs_count

Response Fields

Name

Type

Description

Node name

string

Name of the node

ts

-

Timestamp

avg_vd

string

Value of the metrics in a specific timestamp.

Examples

Request:

curl -X GET
"http://localhost:8081/api/v1/elasticsearch/elasticsearch/kpi_node?start_time=2020-01-01&end_time=2020-04-01&prefix=indices_segments_memory_in_bytes&node=es-node-1" -H  "accept: application/json" -H  "Authorization:  token"

Response:

{
  "es-node-1": [
    {
      "ts": 1585746000000,
      "avg_vd": 780607518
    }
  ]
}
In this section: