Boundary Elasticsearch Plugin
Collects metrics from Elasticsearch.
Prerequisites
| OS | Linux | Windows | SmartOS | OS X |
|---|---|---|---|---|
| Supported | v | v | v | v |
Boundary Meter versions v4.2 or later
- To install new meter go to Settings->Installation or see instructions.
- To upgrade the meter to the latest version - see instructions.
Plugin Setup
In order for the plugin to collect statistics from Elasticsearch, it needs access to the cluster stats, cluster health and nodes stats API endpoint. In a default installation, this would be http://127.0.0.1:9200/_cluster/stats, http://127.0.0.1:9200/_cluster/health, http://127.0.0.1:9200/_nodes/stats but the port or path may be modified in configuration.
Plugin Configuration Fields
| Field Name | Description |
|---|---|
| Source | The Source to display in the legend for the elastic search data.It will default to the hostname of the server. |
| Host | The Elastic Search hostname or IP. |
| Port | The Elastic Search port. |
| Poll Interval | How often should the plugin poll for metrics. |
Metrics Collected
| 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 |
Dashboards
- ES ClusterStats
- ES ClusterStats v2
- ES ClusterHealth
- ES NodesStats
References
None