Collect domain memory stat from KVM (#4402) (#6265)

elastic · Apr 19, 2018 · ccd8a31 · ccd8a31
1 parent 227dc95
commit ccd8a31
Show file tree

Hide file tree

Showing 38 changed files with 24,549 additions and 0 deletions.
diff --git a/NOTICE.txt b/NOTICE.txt
@@ -166,6 +166,34 @@ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+--------------------------------------------------------------------
+Dependency: github.com/davecgh/go-xdr
+Revision: e6a2ba005892b6a5b27cb5352f64c2e96942dd28
+License type (autodetected): MIT
+./metricbeat/module/kvm/vendor/github.com/davecgh/go-xdr/LICENSE:
+--------------------------------------------------------------------
+Copyright (c) 2012-2014 Dave Collins <dave@davec.name>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+--------------------------------------------------------------------
+Dependency: github.com/digitalocean/go-libvirt
+Revision: 59d541f19311883ad82708651353009fb207d8a9
+License type (autodetected): Apache-2.0
+./metricbeat/module/kvm/vendor/github.com/digitalocean/go-libvirt/LICENSE.md:
+--------------------------------------------------------------------
+Apache License 2.0
+
+
 --------------------------------------------------------------------
 Dependency: github.com/docker/distribution
 Revision: 1e2f10eb65743fed02f573d31a4587de09afb20e

diff --git a/metricbeat/NOTICE.txt b/metricbeat/NOTICE.txt
diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -34,6 +34,7 @@ grouped in the following categories:
 * <<exported-fields-kibana>>
 * <<exported-fields-kubernetes-processor>>
 * <<exported-fields-kubernetes>>
+* <<exported-fields-kvm>>
 * <<exported-fields-logstash>>
 * <<exported-fields-memcached>>
 * <<exported-fields-mongodb>>
@@ -7849,6 +7850,74 @@ type: long
 Total inodes
 
 
+--
+
+[[exported-fields-kvm]]
+== kvm fields
+
+experimental[]
+kvm module
+
+
+
+[float]
+== kvm fields
+
+
+
+
+[float]
+== dommemstat fields
+
+dommemstat
+
+
+
+[float]
+== stat fields
+
+Memory stat
+
+
+
+*`kvm.dommemstat.stat.name`*::
++
+--
+type: keyword
+
+Memory stat name
+
+
+--
+
+*`kvm.dommemstat.stat.value`*::
++
+--
+type: long
+
+Memory stat value
+
+
+--
+
+*`kvm.dommemstat.id`*::
++
+--
+type: long
+
+Domain id
+
+
+--
+
+*`kvm.dommemstat.name`*::
++
+--
+type: keyword
+
+Domain name
+
+
 --
 
 [[exported-fields-logstash]]

diff --git a/metricbeat/docs/modules/kvm.asciidoc b/metricbeat/docs/modules/kvm.asciidoc
@@ -0,0 +1,43 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-module-kvm]]
+== kvm module
+
+experimental[]
+
+== kvm module
+
+This is the kvm module.
+
+
+
+[float]
+=== Example configuration
+
+The kvm module supports the standard configuration options that are described
+in <<configuration-metricbeat>>. Here is an example configuration:
+
+[source,yaml]
+----
+metricbeat.modules:
+- module: kvm
+  metricsets: ["dommemstat"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost"]
+
+  # Timeout to connect to Libvirt server
+  #timeout: 1s
+----
+
+[float]
+=== Metricsets
+
+The following metricsets are available:
+
+* <<metricbeat-metricset-kvm-dommemstat,dommemstat>>
+
+include::kvm/dommemstat.asciidoc[]
+
diff --git a/metricbeat/docs/modules/kvm/dommemstat.asciidoc b/metricbeat/docs/modules/kvm/dommemstat.asciidoc
@@ -0,0 +1,23 @@
+////
+This file is generated! See scripts/docs_collector.py
+////
+
+[[metricbeat-metricset-kvm-dommemstat]]
+=== kvm dommemstat metricset
+
+experimental[]
+
+include::../../../module/kvm/dommemstat/_meta/docs.asciidoc[]
+
+
+==== Fields
+
+For a description of each field in the metricset, see the
+<<exported-fields-kvm,exported fields>> section.
+
+Here is an example document generated by this metricset:
+
+[source,json]
+----
+include::../../../module/kvm/dommemstat/_meta/data.json[]
+----
diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc
@@ -70,6 +70,8 @@ This file is generated! See scripts/docs_collector.py
 |<<metricbeat-metricset-kubernetes-state_statefulset,state_statefulset>>   
 |<<metricbeat-metricset-kubernetes-system,system>>   
 |<<metricbeat-metricset-kubernetes-volume,volume>>   
+|<<metricbeat-module-kvm,kvm>>  experimental[]   |image:./images/icon-no.png[No prebuilt dashboards]    |  
+.1+| .1+|  |<<metricbeat-metricset-kvm-dommemstat,dommemstat>> experimental[]  
 |<<metricbeat-module-logstash,Logstash>>  beta[]   |image:./images/icon-no.png[No prebuilt dashboards]    |  
 .2+| .2+|  |<<metricbeat-metricset-logstash-node,node>> beta[]  
 |<<metricbeat-metricset-logstash-node_stats,node_stats>> beta[]  
@@ -146,6 +148,7 @@ include::modules/jolokia.asciidoc[]
 include::modules/kafka.asciidoc[]
 include::modules/kibana.asciidoc[]
 include::modules/kubernetes.asciidoc[]
+include::modules/kvm.asciidoc[]
 include::modules/logstash.asciidoc[]
 include::modules/memcached.asciidoc[]
 include::modules/mongodb.asciidoc[]

diff --git a/metricbeat/include/list.go b/metricbeat/include/list.go
@@ -74,6 +74,8 @@ import (
 	_ "github.com/elastic/beats/metricbeat/module/kubernetes/system"
 	_ "github.com/elastic/beats/metricbeat/module/kubernetes/util"
 	_ "github.com/elastic/beats/metricbeat/module/kubernetes/volume"
+	_ "github.com/elastic/beats/metricbeat/module/kvm"
+	_ "github.com/elastic/beats/metricbeat/module/kvm/dommemstat"
 	_ "github.com/elastic/beats/metricbeat/module/logstash"
 	_ "github.com/elastic/beats/metricbeat/module/logstash/node"
 	_ "github.com/elastic/beats/metricbeat/module/logstash/node_stats"

diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml
@@ -366,6 +366,16 @@ metricbeat.modules:
   metricsets:
     - event
 
+#--------------------------------- kvm Module --------------------------------
+- module: kvm
+  metricsets: ["dommemstat"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost"]
+
+  # Timeout to connect to Libvirt server
+  #timeout: 1s
+
 #------------------------------ Logstash Module ------------------------------
 - module: logstash
   metricsets: ["node", "node_stats"]

diff --git a/metricbeat/module/kvm/_meta/config.yml b/metricbeat/module/kvm/_meta/config.yml
@@ -0,0 +1,8 @@
+- module: kvm
+  metricsets: ["dommemstat"]
+  enabled: false
+  period: 10s
+  hosts: ["localhost"]
+
+  # Timeout to connect to Libvirt server
+  #timeout: 1s
diff --git a/metricbeat/module/kvm/_meta/docs.asciidoc b/metricbeat/module/kvm/_meta/docs.asciidoc
@@ -0,0 +1,4 @@
+== kvm module
+
+This is the kvm module.
+
diff --git a/metricbeat/module/kvm/_meta/fields.yml b/metricbeat/module/kvm/_meta/fields.yml
@@ -0,0 +1,11 @@
+- key: kvm
+  title: "kvm"
+  description: >
+    experimental[]
+
+    kvm module
+  fields:
+    - name: kvm
+      type: group
+      description: >
+      fields:
diff --git a/metricbeat/module/kvm/doc.go b/metricbeat/module/kvm/doc.go
@@ -0,0 +1,2 @@
+// Package kvm is a Metricbeat module that contains MetricSets.
+package kvm
diff --git a/metricbeat/module/kvm/dommemstat/_meta/data.json b/metricbeat/module/kvm/dommemstat/_meta/data.json
@@ -0,0 +1,19 @@
+{
+    "@timestamp":"2016-05-23T08:05:34.853Z",
+    "beat":{
+        "hostname":"beathost",
+        "name":"beathost"
+    },
+    "metricset":{
+        "host":"localhost",
+        "module":"kvm",
+        "name":"dommemstat",
+        "rtt":44269
+    },
+    "kvm":{
+        "dommemstat":{
+            "example": "dommemstat"
+        }
+    },
+    "type":"metricsets"
+}
diff --git a/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc b/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc
@@ -0,0 +1,3 @@
+=== kvm dommemstat MetricSet
+
+This is the dommemstat metricset of the module kvm.
diff --git a/metricbeat/module/kvm/dommemstat/_meta/fields.yml b/metricbeat/module/kvm/dommemstat/_meta/fields.yml
@@ -0,0 +1,26 @@
+- name: dommemstat
+  type: group
+  description: >
+    dommemstat
+  fields:
+      - name: stat
+        type: group
+        description: >
+          Memory stat
+        fields:
+          - name: name
+            type: keyword
+            description: >
+              Memory stat name
+          - name: value
+            type: long
+            description: >
+              Memory stat value
+      - name: id
+        type: long
+        description: >
+          Domain id
+      - name: name
+        type: keyword
+        description: >
+          Domain name
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package kvm is a Metricbeat module that contains MetricSets.
		package kvm
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		=== kvm dommemstat MetricSet

		This is the dommemstat metricset of the module kvm.