{"id":22201772,"url":"https://github.com/claygregory/munin-elasticsearch","last_synced_at":"2025-07-27T04:31:06.374Z","repository":{"id":8928083,"uuid":"10658023","full_name":"claygregory/munin-elasticsearch","owner":"claygregory","description":"Munin plugin for monitoring Elasticsearch nodes, including cache stats, document count, garbage collection, JVM stats, request rates, and store size","archived":false,"fork":false,"pushed_at":"2023-07-15T18:02:49.000Z","size":156,"stargazers_count":8,"open_issues_count":4,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-15T01:50:08.885Z","etag":null,"topics":["elasticsearch","munin","munin-plugins"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/claygregory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-06-13T03:33:35.000Z","updated_at":"2023-03-31T06:41:24.000Z","dependencies_parsed_at":"2022-08-27T01:11:57.592Z","dependency_job_id":null,"html_url":"https://github.com/claygregory/munin-elasticsearch","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claygregory%2Fmunin-elasticsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claygregory%2Fmunin-elasticsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claygregory%2Fmunin-elasticsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claygregory%2Fmunin-elasticsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/claygregory","download_url":"https://codeload.github.com/claygregory/munin-elasticsearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227760018,"owners_count":17815626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","munin","munin-plugins"],"created_at":"2024-12-02T16:10:24.308Z","updated_at":"2024-12-02T16:10:25.471Z","avatar_url":"https://github.com/claygregory.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Munin plugin for elasticsearch\n\nA 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.\n\n## Supported Modes\n\n### Cache\n![](./screenshots/elasticsearch_cache-day.png)\n\n`elasticsearch_cache` - field and query cache stats\n\n### Docs\n![](./screenshots/elasticsearch_docs-day.png)\n\n`elasticsearch_docs` - document count\n\n### Garbage Collection\n![](./screenshots/elasticsearch_gc-day.png)\n\n`elasticsearch_gc` - GC collections/sec\n\n### Garbage Collection Running Time\n![](./screenshots/elasticsearch_gc_time-day.png)\n\n`elasticsearch_gc_time` - GC collection running time in ms\n\n### JVM Heap\n![](./screenshots/elasticsearch_jvm-day.png)\n\n`elasticsearch_jvm` - JVM heap stats\n\n### Operations\n![](./screenshots/elasticsearch_ops-day.png)\n\n`elasticsearch_ops` - index, get, search, delete operations/sec\n\n### Store\n![](./screenshots/elasticsearch_store-day.png)\n\n`elasticsearch_store` - Size of index on disk\n\n\n## Installation\n\nSee 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:\n\n```bash\nln -s /usr/local/munin/lib/plugins/elasticsearch_ /etc/munin/plugins/elasticsearch_jvm\n```\n\n\n## Configuration\n\nYou 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`.\n\n### Variables\n * host - a elasticsearch node capable of providing stats interface (default localhost)\n * port - elasticsearch HTTP API port (default 9200)\n * node - the name of the node to monitor (default _local)\n * user - if HTTP authentication is required, user name\n * pass - if HTTP authentication is required, user password\n\n### Example Config\n```\n[elasticsearch_*]\nenv.host 10.1.2.14\nenv.port 9200\nenv.node pinky rat\nenv.user johnsmith\nenv.user passw0rd\n```\n\n## License\n\nSee the included [LICENSE](LICENSE.md) for rights and limitations under the terms of the MIT license.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaygregory%2Fmunin-elasticsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclaygregory%2Fmunin-elasticsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaygregory%2Fmunin-elasticsearch/lists"}