summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/elasticsearch/README.md
blob: a719a94317933d9b3bafde52fff02673a174ad40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# elasticsearch

This module monitors Elasticsearch performance and health metrics.

It produces:

1.  **Search performance** charts:

    -   Number of queries, fetches
    -   Time spent on queries, fetches
    -   Query and fetch latency

2.  **Indexing performance** charts:

    -   Number of documents indexed, index refreshes, flushes
    -   Time spent on indexing, refreshing, flushing
    -   Indexing and flushing latency

3.  **Memory usage and garbace collection** charts:

    -   JVM heap currently in use, committed
    -   Count of garbage collections
    -   Time spent on garbage collections

4.  **Host metrics** charts:

    -   Available file descriptors in percent
    -   Opened HTTP connections
    -   Cluster communication transport metrics

5.  **Queues and rejections** charts:

    -   Number of queued/rejected threads in thread pool

6.  **Fielddata cache** charts:

    -   Fielddata cache size
    -   Fielddata evictions and circuit breaker tripped count

7.  **Cluster health API** charts:

    -   Cluster status
    -   Nodes and tasks statistics
    -   Shards statistics

8.  **Cluster stats API** charts:

    -   Nodes statistics
    -   Query cache statistics
    -   Docs statistics
    -   Store statistics
    -   Indices and shards statistics

## configuration

Sample:

```yaml
local:
  host               : 'ipaddress'    # Elasticsearch server ip address or hostname
  port               : 'port'         # Port on which elasticsearch listens
  cluster_health     :  True/False    # Calls to cluster health elasticsearch API. Enabled by default.
  cluster_stats      :  True/False    # Calls to cluster stats elasticsearch API. Enabled by default.
```

If no configuration is given, module will fail to run.

---

[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Felasticsearch%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)