README
¶
vCenter Receiver
| Status | |
|---|---|
| Stability | alpha: metrics |
| Distributions | contrib |
| Issues |   |
| Code Owners | @djaglowski, @schmikei | Seeking more code owners! |
This receiver fetches metrics from a vCenter or ESXi host running VMware vSphere APIs.
Prerequisites
This receiver has been built to support ESXi and vCenter versions:
- 8
- 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.ClientConfig. 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 |
| initial_delay | 1s | Duration | Defines how long this receiver waits before starting. |
Example Configuration
receivers:
vcenter:
endpoint: http://localhost:15672
username: otelu
password: ${env:VCENTER_PASSWORD}
collection_interval: 5m
initial_delay: 1s
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
Feature gates
The receiver.vcenter.emitPerfMetricsWithObjects is now stable and will be removed in v0.97.0.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
NewFactory returns the receiver factory for the vcenterreceiver
Types ¶
type Config ¶
type Config struct {
scraperhelper.ControllerConfig `mapstructure:",squash"`
configtls.ClientConfig `mapstructure:"tls,omitempty"`
metadata.MetricsBuilderConfig `mapstructure:",squash"`
Endpoint string `mapstructure:"endpoint"`
Username string `mapstructure:"username"`
Password configopaque.String `mapstructure:"password"`
}
Config is the configuration of the receiver
Source Files
Directories