https://github.com/claygregory/munin-elasticsearch
Munin plugin for monitoring Elasticsearch nodes, including cache stats, document count, garbage collection, JVM stats, request rates, and store size
https://github.com/claygregory/munin-elasticsearch
elasticsearch munin munin-plugins
Last synced: 11 months ago
JSON representation
Munin plugin for monitoring Elasticsearch nodes, including cache stats, document count, garbage collection, JVM stats, request rates, and store size
- Host: GitHub
- URL: https://github.com/claygregory/munin-elasticsearch
- Owner: claygregory
- License: mit
- Created: 2013-06-13T03:33:35.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2023-07-15T18:02:49.000Z (almost 3 years ago)
- Last Synced: 2024-04-15T01:50:08.885Z (about 2 years ago)
- Topics: elasticsearch, munin, munin-plugins
- Language: Ruby
- Homepage:
- Size: 152 KB
- Stars: 8
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Munin plugin for elasticsearch
A Munin plugin for monitoring Elasticsearch nodes. Written in Ruby, depends on [JSON gem](http://rubygems.org/gems/json). 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](http://guide.munin-monitoring.org/) for complete instructions on [plugin usage](http://guide.munin-monitoring.org/en/latest/plugin/use.html). 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:
```bash
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](LICENSE.md) for rights and limitations under the terms of the MIT license.