Add elasticsearch node_stats metricset (#4014)

elastic · Apr 13, 2017 · a9b5334 · a9b5334
1 parent 4840c93
commit a9b5334
Show file tree

Hide file tree

Showing 15 changed files with 1,380 additions and 3 deletions.
diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -1930,6 +1930,157 @@ type: keyword
 Node version.
 
 
+[float]
+== node_stats Fields
+
+node_stats
+
+
+
+[float]
+=== elasticsearch.node_stats.name
+
+type: keyword
+
+Node name.
+
+
+[float]
+== jvm.mem.pools Fields
+
+JVM memory pool stats
+
+
+
+[float]
+== old Fields
+
+Old memory pool stats.
+
+
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.old.max.bytes
+
+type: long
+
+format: bytes
+
+Max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.old.peak.bytes
+
+type: long
+
+format: bytes
+
+Peak bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.old.peak_max.bytes
+
+type: long
+
+format: bytes
+
+Peak max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.old.used.bytes
+
+type: long
+
+format: bytes
+
+Used bytes.
+
+[float]
+== young Fields
+
+Young memory pool stats.
+
+
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.young.max.bytes
+
+type: long
+
+format: bytes
+
+Max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.young.peak.bytes
+
+type: long
+
+format: bytes
+
+Peak bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.young.peak_max.bytes
+
+type: long
+
+format: bytes
+
+Peak max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.young.used.bytes
+
+type: long
+
+format: bytes
+
+Used bytes.
+
+[float]
+== survivor Fields
+
+Survivor memory pool stats.
+
+
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.survivor.max.bytes
+
+type: long
+
+format: bytes
+
+Max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.survivor.peak.bytes
+
+type: long
+
+format: bytes
+
+Peak bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.survivor.peak_max.bytes
+
+type: long
+
+format: bytes
+
+Peak max bytes.
+
+[float]
+=== elasticsearch.node_stats.jvm.mem.pools.survivor.used.bytes
+
+type: long
+
+format: bytes
+
+Used bytes.
+
 [float]
 == stats Fields
 

diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc
@@ -18,7 +18,7 @@ in <<configuration-metricbeat>>. Here is an example configuration:
 ----
 metricbeat.modules:
 #- module: elasticsearch
-#  metricsets: ["node", "stats"]
+#  metricsets: ["node", "node_stats", "stats"]
 #  enabled: true
 #  period: 10s
 #  hosts: ["localhost:9200"]
@@ -32,9 +32,13 @@ The following metricsets are available:
 
 * <<metricbeat-metricset-elasticsearch-node,node>>
 
+* <<metricbeat-metricset-elasticsearch-node_stats,node_stats>>
+
 * <<metricbeat-metricset-elasticsearch-stats,stats>>
 
 include::elasticsearch/node.asciidoc[]
 
+include::elasticsearch/node_stats.asciidoc[]
+
 include::elasticsearch/stats.asciidoc[]
 
diff --git a/metricbeat/docs/modules/elasticsearch/node_stats.asciidoc b/metricbeat/docs/modules/elasticsearch/node_stats.asciidoc
@@ -0,0 +1,19 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-metricset-elasticsearch-node_stats]]
+include::../../../module/elasticsearch/node_stats/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-elasticsearch,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../module/elasticsearch/node_stats/_meta/data.json[]
+----
diff --git a/metricbeat/include/list.go b/metricbeat/include/list.go
@@ -30,6 +30,7 @@ import (
 	_ "github.com/elastic/beats/metricbeat/module/docker/network"
 	_ "github.com/elastic/beats/metricbeat/module/elasticsearch"
 	_ "github.com/elastic/beats/metricbeat/module/elasticsearch/node"
+	_ "github.com/elastic/beats/metricbeat/module/elasticsearch/node_stats"
 	_ "github.com/elastic/beats/metricbeat/module/elasticsearch/stats"
 	_ "github.com/elastic/beats/metricbeat/module/golang"
 	_ "github.com/elastic/beats/metricbeat/module/golang/expvar"

diff --git a/metricbeat/metricbeat.full.yml b/metricbeat/metricbeat.full.yml
@@ -126,7 +126,7 @@ metricbeat.modules:
 
 #---------------------------- elasticsearch Module ---------------------------
 #- module: elasticsearch
-#  metricsets: ["node", "stats"]
+#  metricsets: ["node", "node_stats", "stats"]
 #  enabled: true
 #  period: 10s
 #  hosts: ["localhost:9200"]

diff --git a/metricbeat/module/elasticsearch/_meta/config.yml b/metricbeat/module/elasticsearch/_meta/config.yml
@@ -1,5 +1,5 @@
 #- module: elasticsearch
-#  metricsets: ["node", "stats"]
+#  metricsets: ["node", "node_stats", "stats"]
 #  enabled: true
 #  period: 10s
 #  hosts: ["localhost:9200"]

diff --git a/metricbeat/module/elasticsearch/node_stats/_meta/data.json b/metricbeat/module/elasticsearch/node_stats/_meta/data.json
@@ -0,0 +1,67 @@
+{
+    "@timestamp": "2016-05-23T08:05:34.853Z",
+    "beat": {
+        "hostname": "host.example.com",
+        "name": "host.example.com"
+    },
+    "elasticsearch": {
+        "node_stats": {
+            "jvm": {
+                "mem": {
+                    "pools": {
+                        "old": {
+                            "max": {
+                                "bytes": 362414080
+                            },
+                            "peak": {
+                                "bytes": 212130904
+                            },
+                            "peak_max": {
+                                "bytes": 362414080
+                            },
+                            "used": {
+                                "bytes": 154487944
+                            }
+                        },
+                        "survivor": {
+                            "max": {
+                                "bytes": 17432576
+                            },
+                            "peak": {
+                                "bytes": 17432576
+                            },
+                            "peak_max": {
+                                "bytes": 17432576
+                            },
+                            "used": {
+                                "bytes": 7878680
+                            }
+                        },
+                        "young": {
+                            "max": {
+                                "bytes": 139591680
+                            },
+                            "peak": {
+                                "bytes": 139591680
+                            },
+                            "peak_max": {
+                                "bytes": 139591680
+                            },
+                            "used": {
+                                "bytes": 100266128
+                            }
+                        }
+                    }
+                }
+            },
+            "name": "4Il1NmqoQEi-x8a50GNUIw"
+        }
+    },
+    "metricset": {
+        "host": "elasticsearch:9200",
+        "module": "elasticsearch",
+        "name": "node_stats",
+        "rtt": 115
+    },
+    "type": "metricsets"
+}
diff --git a/metricbeat/module/elasticsearch/node_stats/_meta/docs.asciidoc b/metricbeat/module/elasticsearch/node_stats/_meta/docs.asciidoc
@@ -0,0 +1,3 @@
+=== elasticsearch node_stats MetricSet
+
+This is the node_stats metricset of the module elasticsearch. It fetches data from `/_nodes/_local/stats`. The data received is only for the local node so this metricset has to be run on each elasticsearch node.
diff --git a/metricbeat/module/elasticsearch/node_stats/_meta/fields.yml b/metricbeat/module/elasticsearch/node_stats/_meta/fields.yml
@@ -0,0 +1,89 @@
+- name: node_stats
+  type: group
+  description: >
+    node_stats
+  fields:
+    - name: name
+      type: keyword
+      description: >
+        Node name.
+    - name: jvm.mem.pools
+      type: group
+      description: >
+        JVM memory pool stats
+      fields:
+        - name: old
+          type: group
+          description: >
+            Old memory pool stats.
+          fields:
+            - name: max.bytes
+              type: long
+              format: bytes
+              description:
+                Max bytes.
+            - name: peak.bytes
+              type: long
+              format: bytes
+              description:
+                Peak bytes.
+            - name: peak_max.bytes
+              type: long
+              format: bytes
+              description:
+                Peak max bytes.
+            - name: used.bytes
+              type: long
+              format: bytes
+              description:
+                Used bytes.
+        - name: young
+          type: group
+          description: >
+            Young memory pool stats.
+          fields:
+            - name: max.bytes
+              type: long
+              format: bytes
+              description:
+                Max bytes.
+            - name: peak.bytes
+              type: long
+              format: bytes
+              description:
+                Peak bytes.
+            - name: peak_max.bytes
+              type: long
+              format: bytes
+              description:
+                Peak max bytes.
+            - name: used.bytes
+              type: long
+              format: bytes
+              description:
+                Used bytes.
+        - name: survivor
+          type: group
+          description: >
+            Survivor memory pool stats.
+          fields:
+            - name: max.bytes
+              type: long
+              format: bytes
+              description:
+                Max bytes.
+            - name: peak.bytes
+              type: long
+              format: bytes
+              description:
+                Peak bytes.
+            - name: peak_max.bytes
+              type: long
+              format: bytes
+              description:
+                Peak max bytes.
+            - name: used.bytes
+              type: long
+              format: bytes
+              description:
+                Used bytes.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		=== elasticsearch node_stats MetricSet

		This is the node_stats metricset of the module elasticsearch. It fetches data from `/_nodes/_local/stats`. The data received is only for the local node so this metricset has to be run on each elasticsearch node.