Update vSphere yaml and dimensions (#1148)

* Fix minor problems and flag default metrics in metadata.yaml
* Rename ESX IP dimension 'esx_ip' from 'host_name'
* Remove extraneous 'os_type' dimension from ESX metrics
* Apply esx_ip dimension to VM-level metrics
* Add OS info as dimensions to VM metrics
* Add vCenter IP dimension to all metrics to support multiple vCenters

This is in support of new vSphere built in content:
Issue: https://signalfuse.atlassian.net/browse/INT-1717

pkg/monitors/vsphere/service/gateway.go

@@ -20,15 +20,21 @@ type IGateway interface {
 	queryPerfProviderSummary(mor types.ManagedObjectReference) (*types.QueryPerfProviderSummaryResponse, error)
 	queryPerf(invObjs []*model.InventoryObject, maxSample int32) (*types.QueryPerfResponse, error)
 	retrieveCurrentTime() (*time.Time, error)
+	vcenterName() string
 }
 
 type Gateway struct {
 	ctx    context.Context
 	client *govmomi.Client
+	vcName string
 }
 
 func NewGateway(ctx context.Context, client *govmomi.Client) *Gateway {
-	return &Gateway{ctx, client}
+	return &Gateway{
+		ctx:    ctx,
+		client: client,
+		vcName: client.Client.URL().Host,
+	}
 }
 
 func (g *Gateway) retrievePerformanceManager() (*mo.PerformanceManager, error) {
@@ -102,3 +108,7 @@ func (g *Gateway) queryPerf(invObjs []*model.InventoryObject, maxSample int32) (
 func (g *Gateway) retrieveCurrentTime() (*time.Time, error) {
 	return methods.GetCurrentTime(g.ctx, g.client)
 }
+
+func (g *Gateway) vcenterName() string {
+	return g.vcName
+}

pkg/monitors/vsphere/service/inventory.go

@@ -89,10 +89,10 @@ func (svc *InventorySvc) retrieveCluster(ref types.ManagedObjectReference, inv *
 			return nil, err
 		}
 
-		hostInvObj := model.NewInventoryObject(host.Self, map[string]string{
-			"host_name": host.Name,
-			"os_type":   host.Config.Product.OsType,
-		})
+		hostDims := map[string]string{
+			"esx_ip": host.Name,
+		}
+		hostInvObj := model.NewInventoryObject(host.Self, hostDims)
 		inv.AddObject(hostInvObj)
 
 		for _, vmRef := range host.Vm {
@@ -102,10 +102,15 @@ func (svc *InventorySvc) retrieveCluster(ref types.ManagedObjectReference, inv *
 				return nil, err
 			}
 
-			vmInvObj := model.NewInventoryObject(vm.Self, map[string]string{
-				"vm_name":  vm.Name,
-				"guest_id": vm.Config.GuestId,
-			})
+			vmDims := map[string]string{
+				"vm_name":        vm.Name,           // e.g. "MyDebian10Host"
+				"guest_id":       vm.Config.GuestId, // e.g. "debian10_64Guest"
+				"vm_ip":          vm.Guest.IpAddress,
+				"guest_family":   vm.Guest.GuestFamily,   // e.g. "linuxGuest"
+				"guest_fullname": vm.Guest.GuestFullName, // e.g. "Other 4.x or later Linux (64-bit)"
+			}
+			updateMap(vmDims, hostDims)
+			vmInvObj := model.NewInventoryObject(vm.Self, vmDims)
 			inv.AddObject(vmInvObj)
 		}
 	}

pkg/monitors/vsphere/service/inventory_test.go

@@ -18,9 +18,9 @@ func TestRetrieveInventory(t *testing.T) {
 		case model.HostType:
 			require.Equal(t, "host-0", dims["ref_id"])
 			require.Equal(t, model.HostType, dims["object_type"])
-			require.Equal(t, "foo host", dims["host_name"])
-			require.Equal(t, "foo os type", dims["os_type"])
+			require.Equal(t, "4.4.4.4", dims["esx_ip"])
 		case model.VMType:
+			require.Equal(t, "4.4.4.4", dims["esx_ip"])
 			require.Equal(t, "vm-0", dims["ref_id"])
 			require.Equal(t, model.VMType, dims["object_type"])
 			require.Equal(t, "foo vm", dims["vm_name"])

pkg/monitors/vsphere/service/points.go

@@ -62,6 +62,8 @@ func (svc *PointsSvc) RetrievePoints(vsInfo *model.VsphereInfo, numSamplesReqd i
 				dims["object"] = intSeries.Id.Instance
 			}
 
+			dims["vcenter"] = svc.gateway.vcenterName()
+
 			if len(intSeries.Value) > 0 && intSeries.Value[0] > 0 {
 				svc.log.Debugf(
 					"metric = %s, type = (%s->%s), dims = %v, values = %v",
@@ -93,14 +95,6 @@ func (svc *PointsSvc) RetrievePoints(vsInfo *model.VsphereInfo, numSamplesReqd i
 	return dps, latestSampleTime
 }
 
-func copyMap(in map[string]string) map[string]string {
-	out := make(map[string]string)
-	for k, v := range in {
-		out[k] = v
-	}
-	return out
-}
-
 func statsTypeToMetricType(statsType types.PerfStatsType) datapoint.MetricType {
 	switch statsType {
 	case types.PerfStatsTypeDelta:

pkg/monitors/vsphere/service/points_test.go

@@ -21,4 +21,5 @@ func TestRetrievePoints(t *testing.T) {
 	require.Equal(t, "vsphere.cpu_core_utilization_percent", pt.Metric)
 	require.Equal(t, datapoint.Count, pt.MetricType)
 	require.EqualValues(t, 1.11, pt.Value)
+	require.Equal(t, "my-vc", pt.Dimensions["vcenter"])
 }

pkg/monitors/vsphere/service/service_test.go

@@ -71,7 +71,7 @@ func (g *fakeGateway) retrieveRefProperties(mor types.ManagedObjectReference, ds
 		t.Name = "foo dc"
 	case *mo.HostSystem:
 		t.Self = mor
-		t.Name = "foo host"
+		t.Name = "4.4.4.4"
 		t.Config = &types.HostConfigInfo{
 			Product: types.AboutInfo{
 				OsType: "foo os type",
@@ -84,6 +84,11 @@ func (g *fakeGateway) retrieveRefProperties(mor types.ManagedObjectReference, ds
 		t.Config = &types.VirtualMachineConfigInfo{
 			GuestId: "foo guest id",
 		}
+		t.Guest = &types.GuestInfo{
+			IpAddress:     "1.2.3.4",
+			GuestFamily:   "fooFam",
+			GuestFullName: "fooFullName",
+		}
 	default:
 		return fmt.Errorf("type not found %v", t)
 	}
@@ -140,3 +145,7 @@ func (g *fakeGateway) createRefs(key string, prefix string, size int) []types.Ma
 func (g *fakeGateway) retrieveCurrentTime() (*time.Time, error) {
 	panic("implement me")
 }
+
+func (g *fakeGateway) vcenterName() string {
+	return "my-vc"
+}

pkg/monitors/vsphere/service/util.go

@@ -0,0 +1,15 @@
+package service
+
+func copyMap(in map[string]string) map[string]string {
+	out := make(map[string]string)
+	for k, v := range in {
+		out[k] = v
+	}
+	return out
+}
+
+func updateMap(target, updates map[string]string) {
+	for k, v := range updates {
+		target[k] = v
+	}
+}

pkg/monitors/vsphere/service/util_test.go

@@ -0,0 +1,14 @@
+package service
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestUpdateMap(t *testing.T) {
+	target := map[string]string{"foo": "bar"}
+	updates := map[string]string{"baz": "glarch"}
+	updateMap(target, updates)
+	require.Equal(t, target, map[string]string{"foo": "bar", "baz": "glarch"})
+}