vcenterreceiver

README

vCenter Receiver

This receiver fetches metrics from a vCenter or ESXi host running VMware vSphere APIs.

Supported pipeline types: metrics

🚧 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.5
• 7.0
• 6.7

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> i.e: https://vcsa.hostname.localnet
username		String	Required
password		String	Required
tls		TLSClientSetting	Not Required. Will use defaults for configtls.TLSClientSetting. 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

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 with detailed sample configurations here. TLS config is documented further under the opentelemetry collector's configtls package.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml with further documentation in documentation.md

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type Config
  • func (c *Config) SDKUrl() (*url.URL, error)
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory returns the receiver factory for the vcenterreceiver

Types

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	configtls.TLSClientSetting              `mapstructure:"tls,omitempty"`
	Metrics                                 metadata.MetricsSettings `mapstructure:"metrics"`
	Endpoint                                string                   `mapstructure:"endpoint"`
	Username                                string                   `mapstructure:"username"`
	Password                                string                   `mapstructure:"password"`
}

Config is the configuration of the receiver

func (*Config) SDKUrl

func (c *Config) SDKUrl() (*url.URL, error)

SDKUrl returns the url for the vCenter SDK

func (*Config) Validate

func (c *Config) Validate() error

Validate checks to see if the supplied config will work for the receiver