Skip to content

Munin plugin for monitoring Elasticsearch nodes, including cache stats, document count, garbage collection, JVM stats, request rates, and store size

License

Notifications You must be signed in to change notification settings

claygregory/munin-elasticsearch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Munin plugin for elasticsearch

A Munin plugin for monitoring Elasticsearch nodes. Written in Ruby, depends on JSON gem. Compatible with Elasticsearch 5.x–7.x.

Supported Modes

Cache

elasticsearch_cache - field and query cache stats

Docs

elasticsearch_docs - document count

Garbage Collection

elasticsearch_gc - GC collections/sec

Garbage Collection Running Time

elasticsearch_gc_time - GC collection running time in ms

JVM Heap

elasticsearch_jvm - JVM heap stats

Operations

elasticsearch_ops - index, get, search, delete operations/sec

Store

elasticsearch_store - Size of index on disk

Installation

See the Munin documentation for complete instructions on plugin usage. In short, once elasticsearch_ is in your plugin directory, create symlinks for each desired mode in your Munin service dir (usually /etc/munin/plugins/). For example, to enable JVM monitoring:

ln -s /usr/local/munin/lib/plugins/elasticsearch_ /etc/munin/plugins/elasticsearch_jvm

Configuration

You may also need to create a configuration file for the plugin, if the included defaults aren't suitable to your environment. Usually this would be /etc/munin/plugin-conf.d/elasticsearch.

Variables

  • host - a elasticsearch node capable of providing stats interface (default localhost)
  • port - elasticsearch HTTP API port (default 9200)
  • node - the name of the node to monitor (default _local)
  • user - if HTTP authentication is required, user name
  • pass - if HTTP authentication is required, user password

Example Config

[elasticsearch_*]
env.host 10.1.2.14
env.port 9200
env.node pinky rat
env.user johnsmith
env.user passw0rd

License

See the included LICENSE for rights and limitations under the terms of the MIT license.

About

Munin plugin for monitoring Elasticsearch nodes, including cache stats, document count, garbage collection, JVM stats, request rates, and store size

Topics

Resources

License

Stars

Watchers

Forks

Languages