[vSphere][datastore] Add additional metrics (#40441)

* add data collection * update changelog * update datacollection * update fields.yml * update test files * update field discriptions * address review comments * address review comments * address review commetns * update fields * update usint test * address review comments * update data_test file * update unit test * address review comments * update fields.asci * address review comments * update data_test file * update go.mod file * update NOTICE.txt * address review comment * address review comments * mage update * address review comments * Address review comments --------- Co-authored-by: Niraj Rathod <[email protected]>
elastic · Aug 23, 2024 · 94ca509 · 94ca509
1 parent ee678f1
commit 94ca509
Show file tree

Hide file tree

Showing 9 changed files with 597 additions and 111 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -54,6 +54,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
 - Allow metricsets to report their status via control v2 protocol. {pull}40025[40025]
 - Remove fallback to the node limit for the `kubernetes.pod.cpu.usage.limit.pct` and `kubernetes.pod.memory.usage.limit.pct` metrics calculation
 - Add support for Kibana status metricset in v8 format {pull}40275[40275]
+- Add new metrics for the vSphere Datastore metricset. {pull}40441[40441]
 - Update metrics for the vSphere Host metricset. {pull}40429[40429]
 - Added back `elasticsearch.node.stats.jvm.mem.pools.*` to the `node_stats` metricset {pull}40571[40571]
 

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -66861,54 +66861,108 @@ datastore
 
 
 
-*`vsphere.datastore.name`*::
+*`vsphere.datastore.capacity.free.bytes`*::
 +
 --
-Datastore name
+Free bytes of the datastore.
 
 
-type: keyword
+type: long
+
+format: bytes
+
+--
+
+*`vsphere.datastore.capacity.total.bytes`*::
++
+--
+Total bytes of the datastore.
+
+
+type: long
+
+format: bytes
+
+--
+
+*`vsphere.datastore.capacity.used.bytes`*::
++
+--
+Used bytes of the datastore.
+
+
+type: long
+
+format: bytes
+
+--
+
+*`vsphere.datastore.capacity.used.pct`*::
++
+--
+Percentage of datastore capacity used.
+
+
+type: scaled_float
+
+format: percent
 
 --
 
 *`vsphere.datastore.fstype`*::
 +
 --
-Filesystem type
+Filesystem type.
 
 
 type: keyword
 
 --
 
-*`vsphere.datastore.capacity.total.bytes`*::
+*`vsphere.datastore.host.count`*::
 +
 --
-Total bytes of the datastore
+Number of hosts.
 
 
 type: long
 
-format: bytes
+--
 
+*`vsphere.datastore.host.names`*::
++
 --
+List of all the host names.
 
-*`vsphere.datastore.capacity.free.bytes`*::
+
+type: keyword
+
+--
+
+*`vsphere.datastore.iops`*::
 +
 --
-Free bytes of the datastore
+Storage I/O Control aggregated Input/Output Operations Per Second.
 
 
 type: long
 
-format: bytes
+--
 
+*`vsphere.datastore.name`*::
++
 --
+Datastore name.
 
-*`vsphere.datastore.capacity.used.bytes`*::
+
+type: keyword
+
+--
+
+*`vsphere.datastore.read.bytes`*::
 +
 --
-Used bytes of the datastore
+Rate of reading data from the datastore.
 
 
 type: long
@@ -66917,15 +66971,65 @@ format: bytes
 
 --
 
-*`vsphere.datastore.capacity.used.pct`*::
+*`vsphere.datastore.read.latency.total.ms`*::
 +
 --
-Used percent of the datastore
+Average amount of time for a read operation from the datastore in milliseconds.
 
 
-type: scaled_float
+type: long
 
-format: percent
+--
+
+*`vsphere.datastore.status`*::
++
+--
+Status of the datastore.
+
+
+type: keyword
+
+--
+
+*`vsphere.datastore.vm.count`*::
++
+--
+Number of VMs.
+
+
+type: long
+
+--
+
+*`vsphere.datastore.vm.names`*::
++
+--
+List of all the VM names.
+
+
+type: keyword
+
+--
+
+*`vsphere.datastore.write.bytes`*::
++
+--
+Rate of writing data to the datastore.
+
+
+type: long
+
+format: bytes
+
+--
+
+*`vsphere.datastore.write.latency.total.ms`*::
++
+--
+Average amount of time for a write operation from the datastore in milliseconds.
+
+
+type: long
 
 --
 

diff --git a/metricbeat/module/vsphere/datastore/_meta/data.json b/metricbeat/module/vsphere/datastore/_meta/data.json
@@ -1,34 +1,64 @@
 {
-    "@timestamp": "2017-10-12T08:05:34.853Z",
-    "event": {
-        "dataset": "vsphere.datastore",
-        "duration": 115000,
-        "module": "vsphere"
-    },
-    "metricset": {
-        "name": "datastore",
-        "period": 10000
-    },
-    "service": {
-        "address": "127.0.0.1:33365",
-        "type": "vsphere"
-    },
-    "vsphere": {
-        "datastore": {
-            "capacity": {
-                "free": {
-                    "bytes": 37120094208
+  "@timestamp": "2017-10-12T08:05:34.853Z",
+  "event": {
+      "dataset": "vsphere.datastore",
+      "duration": 115000,
+      "module": "vsphere"
+  },
+  "metricset": {
+      "name": "datastore",
+      "period": 10000
+  },
+  "service": {
+      "address": "127.0.0.1:33365",
+      "type": "vsphere"
+  },
+  "vsphere": {
+      "datastore": {
+          "iops": 0,
+          "host": {
+            "count": 1,
+            "names": [
+              "DC3_H0"
+            ]
+          },
+          "status": "green",
+          "vm": {
+            "count": 6,
+            "names": [
+              "DC3_H0_VM0"
+            ]
+          },
+          "capacity": {
+              "free": {
+                  "bytes": 37120094208
+              },
+              "total": {
+                  "bytes": 74686664704
+              },
+              "used": {
+                  "bytes": 37566570496,
+                  "pct": 0.502988996026061
+              },
+              "read": {
+                  "bytes": 0,
+                  "latency": {
+                    "total": {
+                      "ms": 0
+                    }
+                  }
                 },
-                "total": {
-                    "bytes": 74686664704
-                },
-                "used": {
-                    "bytes": 37566570496,
-                    "pct": 0.502988996026061
+                "write": {
+                  "bytes": 337000,
+                  "latency": {
+                    "total": {
+                      "ms": 0
+                    }
+                  }
                 }
-            },
-            "fstype": "local",
-            "name": "LocalDS_0"
-        }
-    }
+          },
+          "fstype": "local",
+          "name": "LocalDS_0"
+      }
+  }
 }
diff --git a/metricbeat/module/vsphere/datastore/_meta/fields.yml b/metricbeat/module/vsphere/datastore/_meta/fields.yml
@@ -4,32 +4,74 @@
     datastore
   release: ga
   fields:
-    - name: name
-      type: keyword
-      description: >
-        Datastore name
-    - name: fstype
-      type: keyword
-      description: >
-        Filesystem type
-    - name: capacity.total.bytes
+    - name: capacity.free.bytes
       type: long
       description: >
-        Total bytes of the datastore
+        Free bytes of the datastore.
       format: bytes
-    - name: capacity.free.bytes
+    - name: capacity.total.bytes
       type: long
       description: >
-        Free bytes of the datastore
+        Total bytes of the datastore.
       format: bytes
     - name: capacity.used.bytes
       type: long
       description: >
-        Used bytes of the datastore
+        Used bytes of the datastore.
       format: bytes
     - name: capacity.used.pct
       type: scaled_float
       description: >
-        Used percent of the datastore
+        Percentage of datastore capacity used.
       format: percent
+    - name: fstype
+      type: keyword
+      description: >
+        Filesystem type.
+    - name: host.count
+      type: long
+      description: >
+        Number of hosts.
+    - name: host.names
+      type: keyword
+      description: >
+        List of all the host names.
+    - name: iops
+      type: long
+      description: >
+        Storage I/O Control aggregated Input/Output Operations Per Second.
+    - name: name
+      type: keyword
+      description: >
+        Datastore name.
+    - name: read.bytes
+      type: long
+      description: >
+        Rate of reading data from the datastore.
+      format: bytes
+    - name: read.latency.total.ms
+      type: long
+      description: >
+        Average amount of time for a read operation from the datastore in milliseconds.
+    - name: status
+      type: keyword
+      description: >
+        Status of the datastore.
+    - name: vm.count
+      type: long
+      description: >
+        Number of VMs.
+    - name: vm.names
+      type: keyword
+      description: >
+        List of all the VM names.
+    - name: write.bytes
+      type: long
+      description: >
+        Rate of writing data to the datastore.
+      format: bytes
+    - name: write.latency.total.ms
+      type: long
+      description: >
+        Average amount of time for a write operation from the datastore in milliseconds.