Elastic Search plugin

This plugin collects metrics from Elastic Search clusters and their nodes.

Prerequisites

Meter 4.2.0-611 or later must be installed.

The Elastic Search plugin supports the following Operating Systems.

Linux(tick)
Windows(tick)
OS X(tick)

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

FieldDescription
NameThe name of the Elastic Search instance.
HostThe Elastic Search hostname or IP address.
PortThe Elastic Search port. Default value is 9200.
Poll Interval (ms)The frequency (in milliseconds) used to poll for metrics.
SourceThe Source to display in the legend for the elastic search data.It will default to the hostname of the server.

Advanced configuration

To customize this plugin, see Elasticsearch plugin on GitHub.

Plugin metrics

Metric NameDescription
ELASTIC_SEARCH_STATUSCurrent status of the cluster either: 1 green, or 0, either yellow or red
ELASTIC_SEARCH_NODE_COUNTNumber of nodes in the cluster
ELASTIC_SEARCH_INDEX_COUNTNumber of indexes in the cluster
ELASTIC_SEARCH_DOCUMENT_COUNTNumber of documents in all indexes
ELASTIC_SEARCH_STORE_SIZEAmount of storage in bytes used by indexes
ELASTIC_SEARCH_SEGMENT_COUNTTotal number of segments in the cluster
ELASTIC_SEARCH_TOTAL_SHARDSTotal number of shards
ELASTIC_SEARCH_PRIMARY_SHARDSTotal number of primary shards
ELASTIC_SEARCH_FIELDDATA_MEMORY_SIZEAmount of memory in bytes used by the field data caches
ELASTIC_SEARCH_FIELDDATA_EVICTIONSNumber of field data dropped due to LRU (Least Recently Used) policy
ELASTIC_SEARCH_FILTER_CACHE_MEMORY_SIZEAmount of memory in bytes of the filter cache
ELASTIC_SEARCH_FILTER_CACHE_EVICTIONSNumber of filters dropped due to LRU (Least Recently Used) policy
ELASTIC_SEARCH_QUERY_CACHE_MEMORY_SIZEAmount of memory in bytes of the Query cache (added for Elasticsearch 2.x )
ELASTIC_SEARCH_QUERY_CACHE_EVICTIONSNumber of Queries dropped due to LRU (Least Recently Used) policy ( added for Elasticsearch 2.x )
ELASTIC_SEARCH_ID_CACHE_MEMORY_SIZEAmount of memory in bytes of the id cache
ELASTIC_SEARCH_COMPLETION_SIZENumber of completion suggestions returned
ELASTIC_SEARCH_NO_OF_NODESNumber of Nodes
ELASTIC_SEARCH_NO_OF_DATA_NODESNumber of Data Nodes
ELASTIC_SEARCH_ACTIVE_PRIMARY_SHARDSNumber of Active Primary Shards
ELASTIC_SEARCH_ACTIVE_SHARDSNumber of Active Shards
ELASTIC_SEARCH_RELOCATING_SHARDSNumber of Relocating Shards
ELASTIC_SEARCH_INITIALISING_SHARDSNumber of Initialising Shards
ELASTIC_SEARCH_UNASSIGNED_SHARDSNumber of Unassigned Shards
ELASTIC_SEARCH_JVM_UPTIME_IN_MILLISJVM uptime in milliseconds
ELASTIC_SEARCH_JVM_MEM_HEAP_USED_PERCENTJVM heap memory used percent
ELASTIC_SEARCH_PROCESS_OPEN_FILE_DESCRIPTORSProcess open file descriptors
ELASTIC_SEARCH_PROCESS_MAX_FILE_DESCRIPTORSProcess max file descriptors
ELASTIC_SEARCH_FS_DATA_AVAILABLE_IN_BYTESFS data available in bytes
ELASTIC_SEARCH_BREAKERS_FIELDDATA_TRIPPEDBreakers field data tripped
Was this page helpful? Yes No Submitting... Thank you

Comments