[vSphere][datastore] Add additional metrics

CHANGELOG.next.asciidoc

@@ -63,6 +63,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
 - Add support of Graphite series 1.1.0+ tagging extension for statsd module. {pull}39619[39619]
 - 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]
 
 *Osquerybeat*
 

metricbeat/module/vsphere/datastore/_meta/data.json

@@ -15,6 +15,14 @@
     },
     "vsphere": {
         "datastore": {
+            "iops": 0,
+            "host": {
+              "count": 1
+            },
+            "status": "green",
+            "vm": {
+              "count": 6
+            },
             "capacity": {
                 "free": {
                     "bytes": 37120094208
@@ -25,7 +33,23 @@
                 "used": {
                     "bytes": 37566570496,
                     "pct": 0.502988996026061
-                }
+                },
+                "read": {
+                    "bytes": 0,
+                    "latency": {
+                      "total": {
+                        "ms": 0
+                      }
+                    }
+                  },
+                  "write": {
+                    "bytes": 337000,
+                    "latency": {
+                      "total": {
+                        "ms": 0
+                      }
+                    }
+                  }
             },
             "fstype": "local",
             "name": "LocalDS_0"

metricbeat/module/vsphere/datastore/_meta/fields.yml

@@ -4,32 +4,66 @@
     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
+        Used percent of the datastore.
       format: percent
+    - name: fstype
+      type: keyword
+      description: >
+        Filesystem type
+    - name: host.count
+      type: long
+      description: >
+        Number of hosts.
+    - name: iops
+      type: long
+      description: >
+        Storage I/O Control aggregated IOPS.
+    - 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: double
+      description: >
+        Average amount of time for a read operation from the datastore.
+    - name: status
+      type: keyword
+      description: >
+        Status of the datastore.
+    - name: vm.count
+      type: long
+      description: >
+        Number of VMs.
+    - name: write.bytes
+      type: long
+      description: >
+        Rate of writing data to the datastore.
+      format: bytes
+    - name: write.latency.total.ms
+      type: double
+      description: >
+        Average amount of time for a write operation from the datastore.
 

metricbeat/module/vsphere/datastore/data.go

@@ -0,0 +1,74 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package datastore
+
+import (
+	"github.com/vmware/govmomi/vim25/mo"
+
+	"github.com/elastic/elastic-agent-libs/mapstr"
+)
+
+func (m *MetricSet) eventMapping(ds mo.Datastore, perfMertics *PerformanceMetrics) mapstr.M {
+	var usedSpacePercent float64
+	if ds.Summary.Capacity > 0 {
+		usedSpacePercent = float64(ds.Summary.Capacity-ds.Summary.FreeSpace) / float64(ds.Summary.Capacity)
+	}
+	usedSpaceBytes := ds.Summary.Capacity - ds.Summary.FreeSpace
+
+	event := mapstr.M{
+		"read": mapstr.M{
+			"bytes": perfMertics.DsRead * 1000,
+			"latency": mapstr.M{
+				"total": mapstr.M{
+					"ms": perfMertics.DsReadLatency,
+				},
+			},
+		},
+		"write": mapstr.M{
+			"bytes": perfMertics.DsWrite * 1000,
+			"latency": mapstr.M{
+				"total": mapstr.M{
+					"ms": perfMertics.DsWriteLatency,
+				},
+			},
+		},
+		"iops":   perfMertics.DsIops,
+		"name":   ds.Summary.Name,
+		"fstype": ds.Summary.Type,
+		"status": ds.OverallStatus,
+		"host": mapstr.M{
+			"count": len(ds.Host),
+		},
+		"vm": mapstr.M{
+			"count": len(ds.Vm),
+		},
+		"capacity": mapstr.M{
+			"total": mapstr.M{
+				"bytes": ds.Summary.Capacity,
+			},
+			"free": mapstr.M{
+				"bytes": ds.Summary.FreeSpace,
+			},
+			"used": mapstr.M{
+				"bytes": usedSpaceBytes,
+				"pct":   usedSpacePercent,
+			},
+		},
+	}
+	return event
+}

metricbeat/module/vsphere/datastore/data_test.go

@@ -0,0 +1,63 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package datastore
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/vmware/govmomi/vim25/mo"
+	"github.com/vmware/govmomi/vim25/types"
+)
+
+func TestEventMapping(t *testing.T) {
+	var m *MetricSet
+	var DatastoreTest = mo.Datastore{
+		Summary: types.DatastoreSummary{
+			Name:      "datastore-test",
+			Type:      "local",
+			Capacity:  5000000,
+			FreeSpace: 5000000,
+		},
+		ManagedEntity: mo.ManagedEntity{
+			OverallStatus: "green",
+		},
+		Host: []types.DatastoreHostMount{},
+		Vm: []types.ManagedObjectReference{
+			{Type: "VirtualMachine", Value: "vm-test"},
+		},
+	}
+
+	event := m.eventMapping(DatastoreTest, &PerformanceMetrics{})
+
+	VmCount, _ := event.GetValue("vm.count")
+	assert.EqualValues(t, 1, VmCount)
+
+	capacityTotal, _ := event.GetValue("capacity.total.bytes")
+	assert.EqualValues(t, 5000000, capacityTotal)
+
+	capacityFree, _ := event.GetValue("capacity.free.bytes")
+	assert.EqualValues(t, 5000000, capacityFree)
+
+	capacityUsed, _ := event.GetValue("capacity.used.bytes")
+	assert.EqualValues(t, 0, capacityUsed)
+
+	capacityUsedPct, _ := event.GetValue("capacity.used.pct")
+	assert.EqualValues(t, 0, capacityUsedPct)
+
+}