Follow

Elastic Search Plugin

A plugin that collects metrics from Elastic Search clusters and their nodes

Prerequisites
  • Supported OS: Linux, Windows, OS X
  • TrueSight Pulse meter 4.2.0-611 or later
To install new meter go to 'Settings-> Installation' or see instructions.
To upgrade the meter to the latest version see instructions
 
Metrics Collected:
  • ELASTIC_SEARCH_STATUS
  • ELASTIC_SEARCH_NODE_COUNT
  • ELASTIC_SEARCH_INDEX_COUNT
  • ELASTIC_SEARCH_DOCUMENT_COUNT
  • ELASTIC_SEARCH_STORE_SIZE
  • ELASTIC_SEARCH_SEGMENT_COUNT
  • ELASTIC_SEARCH_TOTAL_SHARDS
  • ELASTIC_SEARCH_PRIMARY_SHARDS
  • ELASTIC_SEARCH_FIELDDATA_MEMORY_SIZE
  • ELASTIC_SEARCH_FIELDDATA_EVICTIONS
  • ELASTIC_SEARCH_FILTER_CACHE_MEMORY_SIZE
  • ELASTIC_SEARCH_FILTER_CACHE_EVICTIONS
  • ELASTIC_SEARCH_QUERY_CACHE_MEMORY_SIZE
  • ELASTIC_SEARCH_QUERY_CACHE_EVICTIONS
  • ELASTIC_SEARCH_ID_CACHE_MEMORY_SIZE
  • ELASTIC_SEARCH_COMPLETION_SIZE
  • ELASTIC_SEARCH_NO_OF_NODES
  • ELASTIC_SEARCH_NO_OF_DATA_NODES
  • ELASTIC_SEARCH_ACTIVE_PRIMARY_SHARDS
  • ELASTIC_SEARCH_ACTIVE_SHARDS
  • ELASTIC_SEARCH_RELOCATING_SHARDS
  • ELASTIC_SEARCH_INITIALISING_SHARDS
  • ELASTIC_SEARCH_UNASSIGNED_SHARDS
  • ELASTIC_SEARCH_JVM_UPTIME_IN_MILLIS
  • ELASTIC_SEARCH_JVM_MEM_HEAP_USED_PERCENT
  • ELASTIC_SEARCH_PROCESS_OPEN_FILE_DESCRIPTORS
  • ELASTIC_SEARCH_PROCESS_MAX_FILE_DESCRIPTORS
  • ELASTIC_SEARCH_FS_DATA_AVAILABLE_IN_BYTES
  • ELASTIC_SEARCH_BREAKERS_FIELDDATA_TRIPPED
Installing the plugin
 
1) Log into the Pulse.
 
2) Go to Settings > Plugins
 
3) Click on 'Get Plugins'.
 
4) Scroll to 'elasticsearch' and click 'Install'.
 
5) Pulse provides a list of meters to associate to the plugin. Select a meter.
 
6) An "Add a plugin..." drop down box will display. Click and select 'elasticsearch'.
 
7) Click "Add a Instance" and enter the following 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.
 
8) The following dashboards will be created:
  • ES ClusterStats
  • ES ClusterStats v2
  • ES ClusterHealth
  • ES NodesStats
Have more questions? Submit a request