summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/elasticsearch/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/elasticsearch/README.md')
-rw-r--r--collectors/python.d.plugin/elasticsearch/README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/elasticsearch/README.md b/collectors/python.d.plugin/elasticsearch/README.md
index 211dfabfa..d8d7581bc 100644
--- a/collectors/python.d.plugin/elasticsearch/README.md
+++ b/collectors/python.d.plugin/elasticsearch/README.md
@@ -1,6 +1,12 @@
-# elasticsearch
+<!--
+title: "Elasticsearch monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/elasticsearch/README.md
+sidebar_label: "Elasticsearch"
+-->
-This module monitors [Elasticsearch](https://www.elastic.co/products/elasticsearch) performance and health metrics.
+# Elasticsearch monitoring with Netdata
+
+Monitors [Elasticsearch](https://www.elastic.co/products/elasticsearch) performance and health metrics.
It produces:
@@ -16,7 +22,7 @@ It produces:
- Time spent on indexing, refreshing, flushing
- Indexing and flushing latency
-3. **Memory usage and garbace collection** charts:
+3. **Memory usage and garbage collection** charts:
- JVM heap currently in use, committed
- Count of garbage collections
@@ -58,7 +64,15 @@ It produces:
- Num of replicas
- Health status
-## configuration
+## Configuration
+
+Edit the `python.d/elasticsearch.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/elasticsearch.conf
+```
Sample: