Docs » Supported integrations in Splunk Observability Cloud » Collector components: Receivers » vCenter receiver

Edit this page
Learn how

---

vCenter receiver

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

Prerequisites

This receiver supports ESXi and vCenter versions 7.0 and 8.

To retrieve data you need to assign a read-only user to vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored.

Get started

Follow these steps to configure and activate the component:

1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:

   • Install the Collector for Linux with the installer script

   • Install the Collector for Windows with the installer script

   • Install the Collector for Kubernetes using Helm

2. Configure the receiver as described in the next section.

3. Restart the Collector.

Sample configuration

To activate the vCenter receiver in the Collector, add vecenter to the receivers section of your configuration file, as shown in the following example:

receivers:
  vcenter:

To complete the configuration, include the receiver in the metrics pipeline of the service section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [vcenter]

Configuration example

See the following config example:

vcenter:
  endpoint: http://vcsa.host.localnet
  username: otelu
  password: ${env:VCENTER_PASSWORD}
  collection_interval: 5m
  metrics:
    vcenter.host.cpu.utilization:
      enabled: false

Configuration settings

The following settings are required:

• password

• username

• endpoint. Endpoint to the vCenter Server or ESXi host that has the SDK path enabled.

  • Use the <protocol>://<hostname> format, for example https://vcsa.hostname.localnet.

The following settings are optional:

• collection_interval. 2m by default. This receiver collects metrics on an interval. If the vCenter is large, increase this value.

  • Valid time units are ns, us (or µs), ms, s, m, h.

• initial_delay. 1s by default. Defines how long the receiver waits before starting.

• tls. TLS control. By default insecure settings are rejected and certificate verification is on. Will use defaults for configtls.ClientConfig. Learn more at TLS Configuration Settings in GitHub.

Settings

The following table shows the configuration options for the vCenter receiver:

Name	Type	Default	Description
collection_interval	int64	2m0s	CollectionInterval sets how frequently the scraper should be called and used as the context timeout to ensure that scrapers don't exceed the interval.
initial_delay	int64	1s	InitialDelay sets the initial start delay for the scraper, any non positive value is assumed to be immediately.
timeout	int64		Timeout is an optional value used to set scraper's context deadline.
tls (see fields)	struct		ClientConfig contains TLS configurations that are specific to client connections in addition to the common configurations. This should be used by components configuring TLS client connections.
metrics (see fields)	struct		MetricsConfig provides config for vcenter metrics.
resource_attributes (see fields)	struct		ResourceAttributesConfig provides config for vcenter resource attributes.
endpoint	string
username	string
password	string

Fields of tls

Name	Type	Default	Description
ca_file	string		Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. (optional)
ca_pem	string		In memory PEM encoded cert. (optional)
include_system_ca_certs_pool	bool	false	If true, load system CA certificates pool in addition to the certificates configured in this struct.
cert_file	string		Path to the TLS cert to use for TLS required connections. (optional)
cert_pem	string		In memory PEM encoded TLS cert to use for TLS required connections. (optional)
key_file	string		Path to the TLS key to use for TLS required connections. (optional)
key_pem	string		In memory PEM encoded TLS key to use for TLS required connections. (optional)
min_version	string		MinVersion sets the minimum TLS version that is acceptable. If not set, TLS 1.2 will be used. (optional)
max_version	string		MaxVersion sets the maximum TLS version that is acceptable. If not set, refer to crypto/tls for defaults. (optional)
cipher_suites	slice		CipherSuites is a list of TLS cipher suites that the TLS transport can use. If left blank, a safe default list is used. See https://go.dev/src/crypto/tls/cipher_suites.go for a list of supported cipher suites.
reload_interval	int64		ReloadInterval specifies the duration after which the certificate will be reloaded If not set, it will never be reloaded (optional)
insecure	bool	false	In gRPC and HTTP when set to true, this is used to disable the client transport security. See https://godoc.org/google.golang.org/grpc#WithInsecure for gRPC. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional, default false)
insecure_skip_verify	bool	false	InsecureSkipVerify will enable TLS but not verify the certificate.
server_name_override	string		ServerName requested by client for virtual hosting. This sets the ServerName in the TLSConfig. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional)

Fields of metrics

Name	Type	Default	Description
vcenter.cluster.cpu.effective	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.cpu.limit	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.host.count	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.memory.effective	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.memory.limit	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vm.count	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vm_template.count	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vsan.congestions	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vsan.latency.avg	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vsan.operations	struct		MetricConfig provides common config for a particular metric.
vcenter.cluster.vsan.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.cluster.count	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.cpu.limit	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.datastore.count	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.disk.space	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.host.count	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.memory.limit	struct		MetricConfig provides common config for a particular metric.
vcenter.datacenter.vm.count	struct		MetricConfig provides common config for a particular metric.
vcenter.datastore.disk.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.datastore.disk.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.host.cpu.capacity	struct		MetricConfig provides common config for a particular metric.
vcenter.host.cpu.reserved	struct		MetricConfig provides common config for a particular metric.
vcenter.host.cpu.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.host.cpu.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.host.disk.latency.avg	struct		MetricConfig provides common config for a particular metric.
vcenter.host.disk.latency.max	struct		MetricConfig provides common config for a particular metric.
vcenter.host.disk.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.host.memory.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.host.memory.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.host.network.packet.drop.rate	struct		MetricConfig provides common config for a particular metric.
vcenter.host.network.packet.error.rate	struct		MetricConfig provides common config for a particular metric.
vcenter.host.network.packet.rate	struct		MetricConfig provides common config for a particular metric.
vcenter.host.network.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.host.network.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.host.vsan.cache.hit_rate	struct		MetricConfig provides common config for a particular metric.
vcenter.host.vsan.congestions	struct		MetricConfig provides common config for a particular metric.
vcenter.host.vsan.latency.avg	struct		MetricConfig provides common config for a particular metric.
vcenter.host.vsan.operations	struct		MetricConfig provides common config for a particular metric.
vcenter.host.vsan.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.cpu.shares	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.cpu.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.memory.ballooned	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.memory.granted	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.memory.shares	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.memory.swapped	struct		MetricConfig provides common config for a particular metric.
vcenter.resource_pool.memory.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.cpu.readiness	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.cpu.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.cpu.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.disk.latency.avg	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.disk.latency.max	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.disk.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.disk.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.disk.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.memory.ballooned	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.memory.swapped	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.memory.swapped_ssd	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.memory.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.memory.utilization	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.network.packet.drop.rate	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.network.packet.rate	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.network.throughput	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.network.usage	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.vsan.latency.avg	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.vsan.operations	struct		MetricConfig provides common config for a particular metric.
vcenter.vm.vsan.throughput	struct		MetricConfig provides common config for a particular metric.

Fields of vcenter.cluster.cpu.effective

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.cpu.limit

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.host.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.memory.effective

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.memory.limit

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vm.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vm_template.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vsan.congestions

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vsan.latency.avg

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vsan.operations

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.cluster.vsan.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.cluster.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.cpu.limit

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.datastore.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.disk.space

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.host.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.memory.limit

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datacenter.vm.count

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datastore.disk.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.datastore.disk.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.cpu.capacity

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.cpu.reserved

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.cpu.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.cpu.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.disk.latency.avg

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.disk.latency.max

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.disk.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.memory.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.memory.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.network.packet.drop.rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.network.packet.error.rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.network.packet.rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.network.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.network.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.vsan.cache.hit_rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.vsan.congestions

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.vsan.latency.avg

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.vsan.operations

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.host.vsan.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.cpu.shares

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.cpu.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.memory.ballooned

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.memory.granted

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.memory.shares

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.memory.swapped

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.resource_pool.memory.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.cpu.readiness

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.cpu.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.cpu.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.disk.latency.avg

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.disk.latency.max

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.disk.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.disk.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.disk.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.memory.ballooned

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.memory.swapped

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.memory.swapped_ssd

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.memory.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.memory.utilization

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.network.packet.drop.rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.network.packet.rate

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.network.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.network.usage

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.vsan.latency.avg

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.vsan.operations

Name	Type	Default	Description
enabled	bool	true

Fields of vcenter.vm.vsan.throughput

Name	Type	Default	Description
enabled	bool	true

Fields of resource_attributes

Name	Type	Default	Description
vcenter.cluster.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.datacenter.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.datastore.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.host.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.resource_pool.inventory_path	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.resource_pool.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.virtual_app.inventory_path	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.virtual_app.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.vm.id	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.vm.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.vm_template.id	struct		ResourceAttributeConfig provides common config for a particular resource attribute.
vcenter.vm_template.name	struct		ResourceAttributeConfig provides common config for a particular resource attribute.

Fields of vcenter.cluster.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.datacenter.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.datastore.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.host.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.resource_pool.inventory_path

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.resource_pool.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.virtual_app.inventory_path

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.virtual_app.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.vm.id

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.vm.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.vm_template.id

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Fields of vcenter.vm_template.name

Name	Type	Default	Description
enabled	bool	true
metrics_include (see fields)	slice		Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted.
metrics_exclude (see fields)	slice		Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude.

Fields of metrics_include

Name	Type	Default	Description
strict	string
regexp	string

Fields of metrics_exclude

Name	Type	Default	Description
strict	string
regexp	string

Metrics

The following metrics, resource attributes, and attributes are available.

Name	Type	Unit	Active	Description	Attributes
vcenter.datacenter.cluster.count	Sum	{clusters}	Yes	The number of clusters in the datacenter.	entity_status
vcenter.datacenter.host.count	Sum	{hosts}	Yes	The number of hosts in the datacenter.	entity_status host_power_state
vcenter.datacenter.vm.count	Sum	{virtual_machines}	Yes	The number of VM's in the datacenter.	entity_status vm_count_power_state
vcenter.datacenter.datastore.count	Sum	{datastores}	Yes	The number of datastores in the datacenter.
vcenter.datacenter.disk.space	Sum	By	Yes	The amount of available and used disk space in the datacenter.	disk_state
vcenter.datacenter.cpu.limit	Sum	MHz	Yes	The total amount of CPU available to the datacenter.
vcenter.datacenter.memory.limit	Sum	By	Yes	The total amount of memory available to the datacenter.
vcenter.cluster.cpu.limit	Sum	MHz	Yes	The amount of CPU available to the cluster.
vcenter.cluster.cpu.effective	Sum	MHz	Yes	The effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive.
vcenter.cluster.memory.limit	Sum	By	Yes	The available memory of the cluster.
vcenter.cluster.memory.effective	Sum	By	Yes	The effective available memory of the cluster.
vcenter.cluster.vm.count	Sum	{virtual_machines}	Yes	The number of virtual machines in the cluster.	vm_count_power_state
vcenter.cluster.vm_template.count	Sum	{virtual_machine_templates}	Yes	The number of virtual machine templates in the cluster.
vcenter.cluster.host.count	Sum	{hosts}	Yes	The number of hosts in the cluster.	host_effective
vcenter.cluster.vsan.throughput	Gauge	By/s	Yes	The vSAN throughput of a cluster.	vsan_throughput_direction
vcenter.cluster.vsan.operations	Gauge	{operations/s}	Yes	The vSAN IOPs of a cluster.	vsan_operation_type
vcenter.cluster.vsan.latency.avg	Gauge	us	Yes	The overall cluster latency while accessing vSAN storage.	vsan_latency_type
vcenter.cluster.vsan.congestions	Gauge	{congestions/s}	Yes	The congestions of IOs generated by all vSAN clients in the cluster.
vcenter.datastore.disk.usage	Sum	By	Yes	The amount of space in the datastore.	disk_state
vcenter.datastore.disk.utilization	Gauge	%	Yes	The utilization of the datastore.
vcenter.host.cpu.utilization	Gauge	%	Yes	The CPU utilization of the host system.
vcenter.host.cpu.usage	Sum	MHz	Yes	The amount of CPU used by the host.
vcenter.host.cpu.capacity	Sum	MHz	Yes	Total CPU capacity of the host system.
vcenter.host.cpu.reserved	Sum	MHz	Yes	The CPU of the host reserved for use by virtual machines.	cpu_reservation_type
vcenter.host.disk.throughput	Sum	{KiBy/s}	Yes	Average number of kilobytes read from or written to the disk each second.	disk_direction object_name
vcenter.host.disk.latency.avg	Gauge	ms	Yes	The latency of operations to the host system's disk.	disk_direction object_name
vcenter.host.disk.latency.max	Gauge	ms	Yes	Highest latency value across all disks used by the host.	object_name
vcenter.host.memory.utilization	Gauge	%	Yes	The percentage of the host system's memory capacity that is being utilized.
vcenter.host.memory.usage	Sum	MiBy	Yes	The amount of memory the host system is using.
vcenter.host.memory.capacity	Sum	MiBy	No	Total memory capacity of the host system.
vcenter.host.network.throughput	Sum	{KiBy/s}	Yes	The amount of data that was transmitted or received over the network by the host.	throughput_direction object_name
vcenter.host.network.usage	Sum	{KiBy/s}	Yes	The sum of the data transmitted and received for all the NIC instances of the host.	object_name
vcenter.host.network.packet.error.rate	Gauge	{errors/s}	Yes	The rate of packet errors transmitted or received on the host network.	throughput_direction object_name
vcenter.host.network.packet.rate	Gauge	{packets/s}	Yes	The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.	throughput_direction object_name
vcenter.host.network.packet.drop.rate	Gauge	{packets/s}	Yes	The rate of packets dropped across each physical NIC (network interface controller) instance on the host.	throughput_direction object_name
vcenter.host.vsan.throughput	Gauge	By/s	Yes	The vSAN throughput of a host.	vsan_throughput_direction
vcenter.host.vsan.operations	Gauge	{operations/s}	Yes	The vSAN IOPs of a host.	vsan_operation_type
vcenter.host.vsan.latency.avg	Gauge	us	Yes	The host latency while accessing vSAN storage.	vsan_latency_type
vcenter.host.vsan.congestions	Gauge	{congestions/s}	Yes	The congestions of IOs generated by all vSAN clients in the host.
vcenter.host.vsan.cache.hit_rate	Gauge	%	Yes	The host's read IOs which could be satisfied by the local client cache.
vcenter.resource_pool.memory.usage	Sum	MiBy	Yes	The usage of the memory by the resource pool.	memory_usage_type
vcenter.resource_pool.memory.shares	Sum	{shares}	Yes	The amount of shares of memory in the resource pool.
vcenter.resource_pool.memory.swapped	Sum	MiBy	Yes	The amount of memory that is granted to VMs in the resource pool from the host's swap space.
vcenter.resource_pool.memory.ballooned	Sum	MiBy	Yes	The amount of memory in a resource pool that is ballooned due to virtualization.
vcenter.resource_pool.memory.granted	Sum	MiBy	Yes	The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.	memory_granted_type
vcenter.resource_pool.cpu.usage	Sum	MHz	Yes	The usage of the CPU used by the resource pool.
vcenter.resource_pool.cpu.shares	Sum	{shares}	Yes	The amount of shares of CPU in the resource pool.
vcenter.vm.cpu.time	Gauge	%	No	CPU time spent in idle, ready or wait state.	cpu_state object_name
vcenter.vm.memory.ballooned	Sum	MiBy	Yes	The amount of memory that is ballooned due to virtualization.
vcenter.vm.memory.granted	Sum	MiBy	No	The amount of memory that is granted to a VM.
vcenter.vm.memory.usage	Sum	MiBy	Yes	The amount of memory that is used by the virtual machine.
vcenter.vm.memory.swapped	Sum	MiBy	Yes	The portion of memory that is granted to this VM from the host's swap space.
vcenter.vm.memory.swapped_ssd	Sum	KiBy	Yes	The amount of memory swapped to fast disk device such as SSD.
vcenter.vm.disk.usage	Sum	By	Yes	The amount of storage space used by the virtual machine.	disk_state
vcenter.vm.disk.utilization	Gauge	%	Yes	The utilization of storage on the virtual machine.
vcenter.vm.disk.latency.avg	Gauge	ms	Yes	The latency of operations to the virtual machine's disk.	disk_direction disk_type object_name
vcenter.vm.disk.latency.max	Gauge	ms	Yes	The highest reported total latency (device and kernel times) over an interval of 20 seconds.	object_name
vcenter.vm.disk.throughput	Gauge	{KiBy/s}	Yes	Average number of kilobytes read from or written to the virtual disk each second.	disk_direction object_name
vcenter.vm.network.throughput	Sum	By/s	Yes	The amount of data that was transmitted or received over the network of the virtual machine.	throughput_direction object_name
vcenter.vm.network.broadcast.packet.rate	Gauge	{packets/s}	No	The rate of broadcast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.	throughput_direction object_name
vcenter.vm.network.multicast.packet.rate	Gauge	{packets/s}	No	The rate of multicast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.	throughput_direction object_name
vcenter.vm.network.packet.rate	Gauge	{packets/s}	Yes	The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.	throughput_direction object_name
vcenter.vm.network.packet.drop.rate	Gauge	{packets/s}	Yes	The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.	throughput_direction object_name
vcenter.vm.network.usage	Sum	{KiBy/s}	Yes	The network utilization combined transmit and receive rates during an interval.	object_name
vcenter.vm.cpu.utilization	Gauge	%	Yes	The CPU utilization of the VM.
vcenter.vm.cpu.usage	Sum	MHz	Yes	The amount of CPU used by the VM.
vcenter.vm.cpu.readiness	Gauge	%	Yes	Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
vcenter.vm.memory.utilization	Gauge	%	Yes	The memory utilization of the VM.
vcenter.vm.vsan.throughput	Gauge	By/s	Yes	The vSAN throughput of a virtual machine.	vsan_throughput_direction
vcenter.vm.vsan.operations	Gauge	{operations/s}	Yes	The vSAN IOPs of a virtual machine.	vsan_operation_type
vcenter.vm.vsan.latency.avg	Gauge	us	Yes	The virtual machine latency while accessing vSAN storage.	vsan_latency_type

Resource Attributes

Name	Type	Description
vcenter.datacenter.name	string	The name of the vCenter datacenter.
vcenter.cluster.name	string	The name of the vCenter cluster.
vcenter.host.name	string	The hostname of the vCenter ESXi host.
vcenter.resource_pool.name	string	The name of the resource pool.
vcenter.resource_pool.inventory_path	string	The inventory path of the resource pool.
vcenter.virtual_app.name	string	The name of the vApp.
vcenter.virtual_app.inventory_path	string	The inventory path of the vApp.
vcenter.datastore.name	string	The name of the vCenter datastore.
vcenter.vm.name	string	The name of the virtual machine.
vcenter.vm.id	string	The instance UUID of the virtual machine.
vcenter.vm_template.name	string	The name of the virtual machine template.
vcenter.vm_template.id	string	The instance UUID of the virtual machine template.

Attributes

Name	Type	Description	Values
disk_state	string	The state of storage and whether it is already allocated or free.	available used
disk_type	string	The type of storage device that is being recorded.	virtual physical
memory_usage_type	string	The type of memory usage.	guest host overhead
memory_granted_type	string	The type of memory granted.	private shared
cpu_reservation_type	string	The type of CPU reservation for the host.	total used
host_effective	bool	Whether the host is effective in the vCenter cluster.
host_power_state	string	The current power state of the host.	on off standby unknown
cpu_state	string	CPU time spent in idle, ready or idle state.	idle ready wait
disk_direction	string	The direction of disk latency.	read write
throughput_direction	string	The direction of network throughput.	transmitted received
vm_count_power_state	string	The current power state of the virtual machine.	on off suspended unknown
entity_status	string	The current status of the managed entity.	red yellow green gray
object_name	string	The object on the virtual machine or host that is being reported on.
vsan_throughput_direction	string	The type of vSAN throughput.	read write
vsan_latency_type	string	The type of vSAN latency.	read write
vsan_operation_type	string	The type of vSAN operation.	read write unmap

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

• Submit a case in the Splunk Support Portal .

• Contact Splunk Support .

Available to prospective customers and free trial users

• Ask a question and get answers through community support at Splunk Answers .

• Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Feb 11, 2025.

---

❮

Previous

UDP log receiver

Next

Wavefront receiver

❯

---

• API docs
• Blog
• Training
• Free Trial