otelcol.receiver.vcenter
EXPERIMENTAL: This is an experimental component. Experimental components are subject to frequent breaking changes, and may be removed with no equivalent replacement. To enable and use an experimental component, you must set the
stability.level
flag toexperimental
.
otelcol.receiver.vcenter
accepts metrics from a vCenter or ESXi host running VMware vSphere APIs and forwards it to other otelcol.*
components.
Note
otelcol.receiver.vcenter
is a wrapper over the upstream OpenTelemetry Collectorvcenter
receiver. Bug reports or feature requests will be redirected to the upstream repository, if necessary.
You can specify multiple otelcol.receiver.vcenter
components by giving them different labels.
The full list of metrics that can be collected can be found in vcenter receiver documentation.
Prerequisites
This receiver has been built to support ESXi and vCenter versions:
- 8
- 7.0
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.
Usage
otelcol.receiver.vcenter "<LABEL>" {
endpoint = "<VCENTER_ENDPOINT>"
username = "<VCENTER_USERNAME>"
password = "<VCENTER_PASSWORD>"
output {
metrics = [...]
}
}
Arguments
You can use the following arguments with otelcol.receiver.vcenter
:
endpoint
has the format <protocol>://<hostname>
. For example, https://vcsa.hostname.localnet
.
Blocks
You can use the following blocks with otelcol.receiver.vcenter
:
The > symbol indicates deeper levels of nesting.
For example, tls
> tpm
refers to a tpm
block defined inside a tls
block.
output
Required
The output
block configures a set of components to forward resulting telemetry data to.
The following arguments are supported:
You must specify the output
block, but all its arguments are optional.
By default, telemetry data is dropped.
Configure the metrics
, logs
, and traces
arguments accordingly to send telemetry data to other components.
debug_metrics
The debug_metrics
block configures the metrics that this component generates to monitor its state.
The following arguments are supported:
disable_high_cardinality_metrics
is the Alloy equivalent to the telemetry.disableHighCardinalityMetrics
feature gate in the OpenTelemetry Collector.
It removes attributes that could cause high cardinality metrics.
For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.
Note
If configured,
disable_high_cardinality_metrics
only applies tootelcol.exporter.*
andotelcol.receiver.*
components.
metrics
metric
resource_attributes
resource_attribute
tls
The tls
block configures TLS settings used for a server. If the tls
block
isn’t provided, TLS won’t be used for connections to the server.
The following arguments are supported:
If the server doesn’t support TLS, you must set the insecure
argument to true
.
To disable tls
for connections to the server, set the insecure
argument to true
.
If you set reload_interval
to "0s"
, the certificate never reloaded.
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_file
If cipher_suites
is left blank, a safe default list is used.
Refer to the Go TLS documentation for a list of supported cipher suites.
The curve_preferences
argument determines the set of elliptic curves to prefer during a handshake in preference order.
If not provided, a default list is used.
The set of elliptic curves available are X25519
, P521
, P256
, and P384
.
tpm
The tpm
block configures retrieving the TLS key_file
from a trusted device.
The following arguments are supported:
The trusted platform module (TPM) configuration can be used for loading TLS key from TPM. Currently only TSS2 format is supported.
The path
attribute is not supported on Windows.
Example
otelcol.example.component "<LABEL>" {
...
tls {
...
key_file = "my-tss2-key.key"
tpm {
enabled = true
path = "/dev/tpmrm0"
}
}
}
In the above example, the private key my-tss2-key.key
in TSS2 format will be loaded from the TPM device /dev/tmprm0
.
Exported fields
otelcol.receiver.vcenter
doesn’t export any fields.
Component health
otelcol.receiver.vcenter
is only reported as unhealthy if given an invalid configuration.
Debug information
otelcol.receiver.vcenter
doesn’t expose any component-specific debug information.
Example
This example forwards received telemetry data through a batch processor before finally sending it to an OTLP-capable endpoint:
otelcol.receiver.vcenter "default" {
endpoint = "http://localhost:15672"
username = "otelu"
password = "password"
output {
metrics = [otelcol.processor.batch.default.input]
}
}
otelcol.processor.batch "default" {
output {
metrics = [otelcol.exporter.otlp.default.input]
}
}
otelcol.exporter.otlp "default" {
client {
endpoint = sys.env("<OTLP_ENDPOINT>")
}
}
Compatible components
otelcol.receiver.vcenter
can accept arguments from the following components:
- Components that export OpenTelemetry
otelcol.Consumer
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.