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 | ✅️ |
Windows | ✅️ |
OS X | ✅️ |
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click
> Data Collection, select the TrueSight meter, and select the Sources tab. - Click > Configure Sources.
- Click
- 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.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
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
Field | Description |
|---|---|
Name | The name of the Elastic Search instance. |
Host | The Elastic Search hostname or IP address. |
Port | The Elastic Search port. Default value is 9200. |
Poll Interval (ms) | The frequency (in milliseconds) used to poll for metrics. |
Source | The Source to display in the legend for the elastic search data.It will default to the hostname of the server. |
Plugin metrics
Metric Name | Description |
|---|---|
ELASTIC_SEARCH_STATUS | Current status of the cluster either: 1 green, or 0, either yellow or red |
ELASTIC_SEARCH_NODE_COUNT | Number of nodes in the cluster |
ELASTIC_SEARCH_INDEX_COUNT | Number of indexes in the cluster |
ELASTIC_SEARCH_DOCUMENT_COUNT | Number of documents in all indexes |
ELASTIC_SEARCH_STORE_SIZE | Amount of storage in bytes used by indexes |
ELASTIC_SEARCH_SEGMENT_COUNT | Total number of segments in the cluster |
ELASTIC_SEARCH_TOTAL_SHARDS | Total number of shards |
ELASTIC_SEARCH_PRIMARY_SHARDS | Total number of primary shards |
ELASTIC_SEARCH_FIELDDATA_MEMORY_SIZE | Amount of memory in bytes used by the field data caches |
ELASTIC_SEARCH_FIELDDATA_EVICTIONS | Number of field data dropped due to LRU (Least Recently Used) policy |
ELASTIC_SEARCH_FILTER_CACHE_MEMORY_SIZE | Amount of memory in bytes of the filter cache |
ELASTIC_SEARCH_FILTER_CACHE_EVICTIONS | Number of filters dropped due to LRU (Least Recently Used) policy |
ELASTIC_SEARCH_QUERY_CACHE_MEMORY_SIZE | Amount of memory in bytes of the Query cache (added for Elasticsearch 2.x ) |
ELASTIC_SEARCH_QUERY_CACHE_EVICTIONS | Number of Queries dropped due to LRU (Least Recently Used) policy ( added for Elasticsearch 2.x ) |
ELASTIC_SEARCH_ID_CACHE_MEMORY_SIZE | Amount of memory in bytes of the id cache |
ELASTIC_SEARCH_COMPLETION_SIZE | Number of completion suggestions returned |
ELASTIC_SEARCH_NO_OF_NODES | Number of Nodes |
ELASTIC_SEARCH_NO_OF_DATA_NODES | Number of Data Nodes |
ELASTIC_SEARCH_ACTIVE_PRIMARY_SHARDS | Number of Active Primary Shards |
ELASTIC_SEARCH_ACTIVE_SHARDS | Number of Active Shards |
ELASTIC_SEARCH_RELOCATING_SHARDS | Number of Relocating Shards |
ELASTIC_SEARCH_INITIALISING_SHARDS | Number of Initialising Shards |
ELASTIC_SEARCH_UNASSIGNED_SHARDS | Number of Unassigned Shards |
ELASTIC_SEARCH_JVM_UPTIME_IN_MILLIS | JVM uptime in milliseconds |
ELASTIC_SEARCH_JVM_MEM_HEAP_USED_PERCENT | JVM heap memory used percent |
ELASTIC_SEARCH_PROCESS_OPEN_FILE_DESCRIPTORS | Process open file descriptors |
ELASTIC_SEARCH_PROCESS_MAX_FILE_DESCRIPTORS | Process max file descriptors |
ELASTIC_SEARCH_FS_DATA_AVAILABLE_IN_BYTES | FS data available in bytes |
ELASTIC_SEARCH_BREAKERS_FIELDDATA_TRIPPED | Breakers field data tripped |