Elasticsearch Metrics


All requests to the API must use Basic Authentication and contain a valid username and monitoring API key. API keys are created per user account and can be retrieved via the Instaclustr Console from the Account > API Key tab.


Metrics are requested by constructing a GET request, consisting of:

  • type: Either ‘clusters’, ‘datacentres’ or ‘nodes’.
    • ‘clusters’ returns the metrics for each node in the cluster.
    • ‘datacentres’ returns the metrics for each node belonging to the datacenter.
    • ‘nodes’ returns the metrics for a specific node.
  • UUID or public IP: If the type is set to ‘clusters’ or ‘datacentres’, then the UUID of cluster or datacentre must be specified. However, if the type is set to ‘nodes’, then either the nodes’ UUID or public IP may be specified.
  • metrics: The metrics to return are specified as a comma-delimited query string parameter. Up to 20 metrics may be specified.
  • reportNaN: (true|false) If a metric value is NaN or null, reportNaN determines whether API should report it as NaN. The default behaviour is false and NaN and null will be reported as 0. Setting ‘reportNaN=true’ will return NaN values in the API response.



Elasticsearch specific metrics in the monitoring API begin with the e:: prefix, ie. e::docsCount.


The currently available metrics are:

  • e::memused: Percentage of used memory.
  • e::docsCount: Number of non-deleted documents in the segment, such as 25. This number is based on Lucene documents and may include documents from nested fields.
  • e::docsDeleted: Number of deleted documents in the segment, such as 0. This number is based on Lucene documents. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  • e::jvmheappercent: Percentage of memory currently in use by the heap.
  • e::jvmthreadscount: Number of active threads in use by JVM.
  • e::indextotalpersec: Indices per second.
  • e::querytotalpersec: Queries per second.
  • e::indexlatency: The latency of new indexing operations measured in milliseconds.
  • e::querylatency: The latency of new query operations measured in milliseconds. 
  • e::slaindexlatency: Monitors our SLA indexing latency and alerts when it is above a threshold level. This is the synthetic indexing against an Instaclustr canary index.
  • e::slasearchlatency: Monitors our SLA search latency and alerts when it is above a threshold level. This is the synthetic search query against an Instaclustr canary index.

Impact of slaXXXXlatency metric: High values can indicate that Elasticsearch is struggling to perform indexing/searches in a timely manner implying that normal queries will also be experiencing higher-than-normal latency.

Example: Endpoint to return the document count and SLA search latency for every node in the cluster  with a UUID of e70856aa-d7c2-457a-bff1-a86eb155b693.




Need Support
Learn More

Already have an account?
Login to the Console

Experiencing difficulties on the website or console?
Status page for known incidents

Don’t have an account yet?
Sign up for a free trial

Why sign up?
To experience the ease of creating and managing clusters via the Instaclustr Console.