python reamde update: elasticsearch
Ilya committed
Jan 22, 2017 at 15:45 UTC
60e1df5fe16a8f78a345d1363358b03c8e7be087
1 file changed
+61
python.d/README.md
+61
@@ -303,6 +303,67 @@ If no configuration is given, module will attempt to connect to dovecot using un
303
304
---
305
306
+# elasticsearch
307
+
308
+Module monitor elasticsearch performance and health metrics
309
+
310
+It produces:
311
+
312
+1. **Search performance** charts:
313
+ * Number of queries, fetches
314
+ * Time spent on queries, fetches
315
+ * Query and fetch latency
316
+
317
+2. **Indexing performance** charts:
318
+ * Number of documents indexed, index refreshes, flushes
319
+ * Time spent on indexing, refreshing, flushing
320
+ * Indexing and flushing latency
321
+
322
+3. **Memory usage and garbace collection** charts:
323
+ * JVM heap currently in use, commited
324
+ * Count of garbage collections
325
+ * Time spent on garbage collections
326
+
327
+4. **Host metrics** charts:
328
+ * Available file descriptors in percent
329
+ * Opened HTTP connections
330
+ * Cluster communication transport metrics
331
+
332
+5. **Queues and rejections** charts:
333
+ * Number of queued/rejected threads in thread pool
334
+
335
+6. **Fielddata cache** charts:
336
+ * Fielddata cache size
337
+ * Fielddata evictions and circuit breaker tripped count
338
+
339
+7. **Cluster health API** charts:
340
+ * Cluster status
341
+ * Nodes and tasks statistics
342
+ * Shards statistics
343
+
344
+8. **Cluster stats API** charts:
345
+ * Nodes statistics
346
+ * Query cache statistics
347
+ * Docs statistics
348
+ * Store statistics
349
+ * Indices and shards statistics
350
+
351
+### configuration
352
+
353
+Sample:
354
+
355
+```yaml
356
+local:
357
+ host : 'ipaddress' # Server ip address or hostname
358
+ port : 'password' # Port on which elasticsearch listed
359
+ cluster_health : True/False # Calls to cluster health elasticsearch API. Enabled by default.
360
+ cluster_stats : True/False # Calls to cluster stats elasticsearch API. Enabled by default.
361
+```
362
+
363
+If no configuration is given, module will fail to run.
364
+
365
+---
366
+
367
# exim
368
369
Simple module executing `exim -bpc` to grab exim queue.