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:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the receiver as described in the next section.
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:

Metrics 🔗

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

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.

Related Topics