Home

/elasticsearch/{cluster}/kpi_index

Returns metric values of all the indices.

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

Name

Type

Description

{cluster}

string

Name of the cluster.

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

string

Any of the following metrics:

  • search_rate

  • indexing_rate

  • indexing_latency

  • segments_count

  • fetch_latency

  • fetch_rate

  • flush_latency

  • flush_rate

Response Fields

Name

Type

Description

indices

string

Name of the index

ts

-

Timestamp

avg_vd

string

Value of a 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: JWT token"

Response:

{
  ".kibana_1": [
    {
      "ts": 1585746000000,
      "avg_vd": null
    }
  ],
  ".kibana_2": [
    {
      "ts": 1585746000000,
      "avg_vd": null
    }
  ]
}

In case you want to get metric values of a specific index, then you must pass the index parameter along with the request.

Request
GET http://unravel-host:8081/api/v1/elasticsearch/elasticsearch/kpi_node?start_time={date}&end_time={date}&prefix=indices_segments_memory_in_bytes&node=nod name&index={index name}"

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

string

Any of the following metrics:

  • search_rate

  • indexing_rate

  • indexing_latency

  • segments_count

  • fetch_latency

  • fetch_rate

  • flush_latency

  • flush_rate

index

string

Name of the index.

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&index=.kibana_1" -H  "accept: application/json" -H  "Authorization: JWT Token

Response:

{
  ".kibana_1": [
    {
      "ts": 1585746000000,
      "avg_vd": null
    }
  
  ]
}
In this section: