[receiver/vcenter] Construct MetricsReceiver Component

.github/CODEOWNERS

@@ -162,6 +162,7 @@ receiver/statsdreceiver/                             @open-telemetry/collector-c
 receiver/syslogreceiver/                             @open-telemetry/collector-contrib-approvers @djaglowski
 receiver/tcplogreceiver/                             @open-telemetry/collector-contrib-approvers @djaglowski
 receiver/udplogreceiver/                             @open-telemetry/collector-contrib-approvers @djaglowski
+receiver/vcenterreceiver/                            @open-telemetry/collector-contrib-approvers @djaglowski @schmikei
 receiver/wavefrontreceiver/                          @open-telemetry/collector-contrib-approvers @pjanotti
 receiver/windowsperfcountersreceiver/                @open-telemetry/collector-contrib-approvers @dashpole
 receiver/zipkinreceiver/                             @open-telemetry/collector-contrib-approvers @pmm-sumo

CHANGELOG.md

@@ -109,6 +109,7 @@
 ### 🚀 New components 🚀
 
 - `iisreceiver`: Add implementation of IIS Metric Receiver (#8832)
+- `vcenterreceiver`: Add metrics receiver for new vcenterreceiver component (#9224)
 - `sqlserverreceiver`: Add implementation of SQL Server Metric Receiver (#8398)
 - `activedirectorydsreceiver`: Add implementation of Active Directory Domain Services metric receiver (#9359)
 

cmd/configschema/go.mod

@@ -385,6 +385,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/syslogreceiver v0.51.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver v0.51.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver v0.51.0 // indirect
+	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver v0.51.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver v0.51.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsperfcountersreceiver v0.51.0 // indirect
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zipkinreceiver v0.51.0 // indirect
@@ -455,6 +456,7 @@ require (
 	github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
 	github.com/vmware/go-vmware-nsxt v0.0.0-20220328155605-f49a14c1ef5f // indirect
+	github.com/vmware/govmomi v0.28.0 // indirect
 	github.com/wavefronthq/wavefront-sdk-go v0.9.11 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.1 // indirect
@@ -839,6 +841,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplo
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver => ../../receiver/udplogreceiver
 
+replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver => ../../receiver/vcenterreceiver
+
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver => ../../receiver/wavefrontreceiver
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsperfcountersreceiver => ../../receiver/windowsperfcountersreceiver

go.mod

@@ -132,6 +132,7 @@ require (
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/syslogreceiver v0.51.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver v0.51.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver v0.51.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver v0.51.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver v0.51.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsperfcountersreceiver v0.51.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zipkinreceiver v0.51.0
@@ -456,6 +457,7 @@ require (
 	github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect
 	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
 	github.com/vmware/go-vmware-nsxt v0.0.0-20220328155605-f49a14c1ef5f // indirect
+	github.com/vmware/govmomi v0.28.0 // indirect
 	github.com/wavefronthq/wavefront-sdk-go v0.9.11 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.1 // indirect
@@ -841,6 +843,8 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplo
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver => ./receiver/udplogreceiver
 
+replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver => ./receiver/vcenterreceiver
+
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver => ./receiver/wavefrontreceiver
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsperfcountersreceiver => ./receiver/windowsperfcountersreceiver

internal/components/components.go

@@ -152,6 +152,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/syslogreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/wavefrontreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsperfcountersreceiver"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/zipkinreceiver"
@@ -245,6 +246,7 @@ func Components() (component.Factories, error) {
 		syslogreceiver.NewFactory(),
 		tcplogreceiver.NewFactory(),
 		udplogreceiver.NewFactory(),
+		vcenterreceiver.NewFactory(),
 		zipkinreceiver.NewFactory(),
 	}
 	receivers = append(receivers, extraReceivers()...)

internal/components/receivers_test.go

@@ -296,6 +296,9 @@ func TestDefaultReceivers(t *testing.T) {
 				return cfg
 			},
 		},
+		{
+			receiver: "vcenter",
+		},
 	}
 
 	assert.Len(t, tests, len(rcvrFactories), "All receivers must be added to the lifecycle suite")

receiver/vcenterreceiver/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

receiver/vcenterreceiver/README.md

@@ -0,0 +1,46 @@
+# vCenter Receiver
+
+This receiver fetches metrics from a vCenter or ESXi host running VMware vSphere APIs.
+
+Supported pipeline types: `metrics`
+
+> :construction: This receiver is in **Alpha**. Configuration fields and metric data model are subject to change.
+
+## Prerequisites
+
+This receiver has been built to support ESXi and vCenter versions:
+
+- 7.0
+- 6.7
+- 7.5
+
+A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them.
+
+## Configuration
+
+
+| Parameter | Default | Type | Notes |
+| --- | --- | --- | --- |
+| endpoint |  | String | Endpoint to the vCenter Server or ESXi host that has the sdk path enabled. Required. The expected format is `<protocol>://<hostname>` <br><br> i.e: `https://vcsa.hostname.localnet` |
+| username |  | String | Required |
+| password |  | String | Required |
+| tls | | TLSClientSetting | Not Required. Will use defaults for [configtls.TLSClientSetting](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md). By default insecure settings are rejected and certificate verification is on. |
+| collection_interval | 2m | Duration | This receiver collects metrics on an interval. If the vCenter is fairly large, this value may need to be increased. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h` |
+
+### Example Configuration
+
+```yaml
+receivers:
+  vcenter:
+    endpoint: http://localhost:15672
+    username: otelu
+    password: $VCENTER_PASSWORD
+    collection_interval: 5m
+    metrics: []
+```
+
+The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
+
+## Metrics
+
+Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml) with further documentation in [documentation.md](./documentation.md)

receiver/vcenterreceiver/client.go

@@ -0,0 +1,154 @@
+// Copyright  The OpenTelemetry Authors
+//
+// Licensed 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 vcenterreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver"
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+
+	"github.com/vmware/govmomi"
+	"github.com/vmware/govmomi/find"
+	"github.com/vmware/govmomi/object"
+	"github.com/vmware/govmomi/performance"
+	"github.com/vmware/govmomi/property"
+	"github.com/vmware/govmomi/vim25"
+	vt "github.com/vmware/govmomi/vim25/types"
+)
+
+// vcenterClient is a client that
+type vcenterClient struct {
+	moClient  *govmomi.Client
+	vimDriver *vim25.Client
+	finder    *find.Finder
+	pc        *property.Collector
+	pm        *performance.Manager
+	cfg       *Config
+}
+
+func newVcenterClient(c *Config) *vcenterClient {
+	return &vcenterClient{
+		cfg: c,
+	}
+}
+
+// EnsureConnection will establish a connection to the vSphere SDK if not already established
+func (vc *vcenterClient) EnsureConnection(ctx context.Context) error {
+	if vc.moClient != nil {
+		return nil
+	}
+
+	sdkURL, err := vc.cfg.SDKUrl()
+	if err != nil {
+		return err
+	}
+	client, err := govmomi.NewClient(ctx, sdkURL, vc.cfg.Insecure)
+	if err != nil {
+		return fmt.Errorf("unable to connect to vSphere SDK on listed endpoint: %w", err)
+	}
+	tlsCfg, err := vc.cfg.LoadTLSConfig()
+	if err != nil {
+		return err
+	}
+	client.DefaultTransport().TLSClientConfig = tlsCfg
+	user := url.UserPassword(vc.cfg.Username, vc.cfg.Password)
+	err = client.Login(ctx, user)
+	if err != nil {
+		return fmt.Errorf("unable to login to vcenter sdk: %w", err)
+	}
+	vc.moClient = client
+	vc.vimDriver = client.Client
+	vc.pc = property.DefaultCollector(vc.vimDriver)
+	vc.finder = find.NewFinder(vc.vimDriver)
+	vc.pm = performance.NewManager(vc.vimDriver)
+	return nil
+}
+
+// Disconnect will logout of the autenticated session
+func (vc *vcenterClient) Disconnect(ctx context.Context) error {
+	if vc.moClient != nil {
+		return vc.moClient.Logout(ctx)
+	}
+	return nil
+}
+
+// Clusters returns the clusterComputeResources of the vSphere SDK
+func (vc *vcenterClient) Datacenters(ctx context.Context) ([]*object.Datacenter, error) {
+	datacenters, err := vc.finder.DatacenterList(ctx, "*")
+	if err != nil {
+		return []*object.Datacenter{}, fmt.Errorf("unable to get datacenter lists: %w", err)
+	}
+	return datacenters, nil
+}
+
+// Clusters returns the clusterComputeResources of the vSphere SDK
+func (vc *vcenterClient) Clusters(ctx context.Context, datacenter *object.Datacenter) ([]*object.ClusterComputeResource, error) {
+	vc.finder = vc.finder.SetDatacenter(datacenter)
+	clusters, err := vc.finder.ClusterComputeResourceList(ctx, "*")
+	if err != nil {
+		return []*object.ClusterComputeResource{}, err
+	}
+	return clusters, nil
+}
+
+// ResourcePools returns the resourcePools in the vSphere SDK
+func (vc *vcenterClient) ResourcePools(ctx context.Context) ([]*object.ResourcePool, error) {
+	rps, err := vc.finder.ResourcePoolList(ctx, "*")
+	if err != nil {
+		return nil, fmt.Errorf("unable to retrieve resource pools: %w", err)
+	}
+	return rps, err
+}
+
+func (vc *vcenterClient) VMs(ctx context.Context) ([]*object.VirtualMachine, error) {
+	vms, err := vc.finder.VirtualMachineList(ctx, "*")
+	if err != nil {
+		return nil, fmt.Errorf("unable to retrieve resource pools: %w", err)
+	}
+	return vms, err
+}
+
+type perfSampleResult struct {
+	counters map[string]*vt.PerfCounterInfo
+	results  []performance.EntityMetric
+}
+
+func (vc *vcenterClient) performanceQuery(
+	ctx context.Context,
+	spec vt.PerfQuerySpec,
+	names []string,
+	objs []vt.ManagedObjectReference,
+) (*perfSampleResult, error) {
+	if vc.pm == nil {
+		return &perfSampleResult{}, nil
+	}
+	vc.pm.Sort = true
+	sample, err := vc.pm.SampleByName(ctx, spec, names, objs)
+	if err != nil {
+		return nil, err
+	}
+	result, err := vc.pm.ToMetricSeries(ctx, sample)
+	if err != nil {
+		return nil, err
+	}
+	counterInfoByName, err := vc.pm.CounterInfoByName(ctx)
+	if err != nil {
+		return nil, err
+	}
+	return &perfSampleResult{
+		counters: counterInfoByName,
+		results:  result,
+	}, nil
+}

receiver/vcenterreceiver/client_test.go

@@ -0,0 +1,66 @@
+// Copyright  The OpenTelemetry Authors
+//
+// Licensed 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 vcenterreceiver // import github.com/open-telemetry/opentelemetry-collector-contrib/receiver/vcenterreceiver
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/vmware/govmomi/find"
+	"github.com/vmware/govmomi/simulator"
+	"github.com/vmware/govmomi/vim25"
+)
+
+func TestGetClusters(t *testing.T) {
+	simulator.Test(func(ctx context.Context, c *vim25.Client) {
+		finder := find.NewFinder(c)
+		client := vcenterClient{
+			vimDriver: c,
+			finder:    finder,
+		}
+		dc, err := finder.DefaultDatacenter(ctx)
+		require.NoError(t, err)
+		clusters, err := client.Clusters(ctx, dc)
+		require.NoError(t, err)
+		require.NotEmpty(t, clusters, 0)
+	})
+}
+
+func TestGetResourcePools(t *testing.T) {
+	simulator.Test(func(ctx context.Context, c *vim25.Client) {
+		finder := find.NewFinder(c)
+		client := vcenterClient{
+			vimDriver: c,
+			finder:    finder,
+		}
+		resourcePools, err := client.ResourcePools(ctx)
+		require.NoError(t, err)
+		require.NotEmpty(t, resourcePools)
+	})
+}
+
+func TestGetVMs(t *testing.T) {
+	simulator.Test(func(ctx context.Context, c *vim25.Client) {
+		finder := find.NewFinder(c)
+		client := vcenterClient{
+			vimDriver: c,
+			finder:    finder,
+		}
+		vms, err := client.VMs(ctx)
+		require.NoError(t, err)
+		require.NotEmpty(t, vms)
+	})
+}