vcenter

Documentation

Overview

Package vcenter provides an otelcol.receiver.vcenter component.

Index

• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args Arguments) Validate() error
• type MetricConfig
  • func (r *MetricConfig) Convert() map[string]interface{}
• type MetricsBuilderConfig
  • func (args *MetricsBuilderConfig) Convert() map[string]interface{}
  • func (mbc *MetricsBuilderConfig) SetToDefault()
• type MetricsConfig
  • func (args *MetricsConfig) Convert() map[string]interface{}
  • func (args *MetricsConfig) SetToDefault()
• type ResourceAttributeConfig
  • func (r *ResourceAttributeConfig) Convert() map[string]interface{}
• type ResourceAttributesConfig
  • func (args *ResourceAttributesConfig) Convert() map[string]interface{}
  • func (args *ResourceAttributesConfig) SetToDefault()

Types

type Arguments

type Arguments struct {
	Endpoint string            `alloy:"endpoint,attr"`
	Username string            `alloy:"username,attr"`
	Password alloytypes.Secret `alloy:"password,attr"`

	MetricsBuilderConfig MetricsBuilderConfig `alloy:",squash"`

	ScraperControllerArguments otelcol.ScraperControllerArguments `alloy:",squash"`
	TLS                        otelcol.TLSClientArguments         `alloy:"tls,block,optional"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`

	// Output configures where to send received data. Required.
	Output *otelcol.ConsumerArguments `alloy:"output,block"`
}

Arguments configures the otelcol.receiver.vcenter component.

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements receiver.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements receiver.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component

Exporters implements receiver.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension

Extensions implements receiver.Arguments.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements receiver.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (Arguments) Validate

func (args Arguments) Validate() error

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

type MetricConfig

type MetricConfig struct {
	Enabled bool `alloy:"enabled,attr"`
}

func (*MetricConfig) Convert

func (r *MetricConfig) Convert() map[string]interface{}

type MetricsBuilderConfig

type MetricsBuilderConfig struct {
	Metrics            MetricsConfig            `alloy:"metrics,block,optional"`
	ResourceAttributes ResourceAttributesConfig `alloy:"resource_attributes,block,optional"`
}

func (*MetricsBuilderConfig) Convert

func (args *MetricsBuilderConfig) Convert() map[string]interface{}

func (*MetricsBuilderConfig) SetToDefault

func (mbc *MetricsBuilderConfig) SetToDefault()

type MetricsConfig

type MetricsConfig struct {
	VcenterClusterCPUEffective         MetricConfig `alloy:"vcenter.cluster.cpu.effective,block,optional"`
	VcenterClusterCPULimit             MetricConfig `alloy:"vcenter.cluster.cpu.limit,block,optional"`
	VcenterClusterHostCount            MetricConfig `alloy:"vcenter.cluster.host.count,block,optional"`
	VcenterClusterMemoryEffective      MetricConfig `alloy:"vcenter.cluster.memory.effective,block,optional"`
	VcenterClusterMemoryLimit          MetricConfig `alloy:"vcenter.cluster.memory.limit,block,optional"`
	VcenterClusterVMCount              MetricConfig `alloy:"vcenter.cluster.vm.count,block,optional"`
	VcenterClusterVMTemplateCount      MetricConfig `alloy:"vcenter.cluster.vm_template.count,block,optional"`
	VcenterClusterVsanCongestions      MetricConfig `alloy:"vcenter.cluster.vsan.congestions,block,optional"`
	VcenterClusterVsanLatencyAvg       MetricConfig `alloy:"vcenter.cluster.vsan.latency.avg,block,optional"`
	VcenterClusterVsanOperations       MetricConfig `alloy:"vcenter.cluster.vsan.operations,block,optional"`
	VcenterClusterVsanThroughput       MetricConfig `alloy:"vcenter.cluster.vsan.throughput,block,optional"`
	VcenterDatacenterClusterCount      MetricConfig `alloy:"vcenter.datacenter.cluster.count,block,optional"`
	VcenterDatacenterCPULimit          MetricConfig `alloy:"vcenter.datacenter.cpu.limit,block,optional"`
	VcenterDatacenterDatastoreCount    MetricConfig `alloy:"vcenter.datacenter.datastore.count,block,optional"`
	VcenterDatacenterDiskSpace         MetricConfig `alloy:"vcenter.datacenter.disk.space,block,optional"`
	VcenterDatacenterHostCount         MetricConfig `alloy:"vcenter.datacenter.host.count,block,optional"`
	VcenterDatacenterMemoryLimit       MetricConfig `alloy:"vcenter.datacenter.memory.limit,block,optional"`
	VcenterDatacenterVMCount           MetricConfig `alloy:"vcenter.datacenter.vm.count,block,optional"`
	VcenterDatastoreDiskUsage          MetricConfig `alloy:"vcenter.datastore.disk.usage,block,optional"`
	VcenterDatastoreDiskUtilization    MetricConfig `alloy:"vcenter.datastore.disk.utilization,block,optional"`
	VcenterHostCPUCapacity             MetricConfig `alloy:"vcenter.host.cpu.capacity,block,optional"`
	VcenterHostCPUReserved             MetricConfig `alloy:"vcenter.host.cpu.reserved,block,optional"`
	VcenterHostCPUUsage                MetricConfig `alloy:"vcenter.host.cpu.usage,block,optional"`
	VcenterHostCPUUtilization          MetricConfig `alloy:"vcenter.host.cpu.utilization,block,optional"`
	VcenterHostDiskLatencyAvg          MetricConfig `alloy:"vcenter.host.disk.latency.avg,block,optional"`
	VcenterHostDiskLatencyMax          MetricConfig `alloy:"vcenter.host.disk.latency.max,block,optional"`
	VcenterHostDiskThroughput          MetricConfig `alloy:"vcenter.host.disk.throughput,block,optional"`
	VcenterHostMemoryUsage             MetricConfig `alloy:"vcenter.host.memory.usage,block,optional"`
	VcenterHostMemoryUtilization       MetricConfig `alloy:"vcenter.host.memory.utilization,block,optional"`
	VcenterHostNetworkPacketRate       MetricConfig `alloy:"vcenter.host.network.packet.rate,block,optional"`
	VcenterHostNetworkPacketErrorRate  MetricConfig `alloy:"vcenter.host.network.packet.error.rate,block,optional"`
	VcenterHostNetworkPacketDropRate   MetricConfig `alloy:"vcenter.host.network.packet.drop.rate,block,optional"`
	VcenterHostNetworkThroughput       MetricConfig `alloy:"vcenter.host.network.throughput,block,optional"`
	VcenterHostNetworkUsage            MetricConfig `alloy:"vcenter.host.network.usage,block,optional"`
	VcenterHostVsanCacheHitRate        MetricConfig `alloy:"vcenter.host.vsan.cache.hit_rate,block,optional"`
	VcenterHostVsanCongestions         MetricConfig `alloy:"vcenter.host.vsan.congestions,block,optional"`
	VcenterHostVsanLatencyAvg          MetricConfig `alloy:"vcenter.host.vsan.latency.avg,block,optional"`
	VcenterHostVsanOperations          MetricConfig `alloy:"vcenter.host.vsan.operations,block,optional"`
	VcenterHostVsanThroughput          MetricConfig `alloy:"vcenter.host.vsan.throughput,block,optional"`
	VcenterResourcePoolCPUShares       MetricConfig `alloy:"vcenter.resource_pool.cpu.shares,block,optional"`
	VcenterResourcePoolCPUUsage        MetricConfig `alloy:"vcenter.resource_pool.cpu.usage,block,optional"`
	VcenterResourcePoolMemoryBallooned MetricConfig `alloy:"vcenter.resource_pool.memory.ballooned,block,optional"`
	VcenterResourcePoolMemoryGranted   MetricConfig `alloy:"vcenter.resource_pool.memory.granted,block,optional"`
	VcenterResourcePoolMemoryShares    MetricConfig `alloy:"vcenter.resource_pool.memory.shares,block,optional"`
	VcenterResourcePoolMemorySwapped   MetricConfig `alloy:"vcenter.resource_pool.memory.swapped,block,optional"`
	VcenterResourcePoolMemoryUsage     MetricConfig `alloy:"vcenter.resource_pool.memory.usage,block,optional"`
	VcenterVMCPUReadiness              MetricConfig `alloy:"vcenter.vm.cpu.readiness,block,optional"`
	VcenterVMCPUUsage                  MetricConfig `alloy:"vcenter.vm.cpu.usage,block,optional"`
	VcenterVMCPUUtilization            MetricConfig `alloy:"vcenter.vm.cpu.utilization,block,optional"`
	VcenterVMDiskLatencyAvg            MetricConfig `alloy:"vcenter.vm.disk.latency.avg,block,optional"`
	VcenterVMDiskLatencyMax            MetricConfig `alloy:"vcenter.vm.disk.latency.max,block,optional"`
	VcenterVMDiskThroughput            MetricConfig `alloy:"vcenter.vm.disk.throughput,block,optional"`
	VcenterVMDiskUsage                 MetricConfig `alloy:"vcenter.vm.disk.usage,block,optional"`
	VcenterVMDiskUtilization           MetricConfig `alloy:"vcenter.vm.disk.utilization,block,optional"`
	VcenterVMMemoryBallooned           MetricConfig `alloy:"vcenter.vm.memory.ballooned,block,optional"`
	VcenterVMMemorySwapped             MetricConfig `alloy:"vcenter.vm.memory.swapped,block,optional"`
	VcenterVMMemorySwappedSsd          MetricConfig `alloy:"vcenter.vm.memory.swapped_ssd,block,optional"`
	VcenterVMMemoryUsage               MetricConfig `alloy:"vcenter.vm.memory.usage,block,optional"`
	VcenterVMMemoryUtilization         MetricConfig `alloy:"vcenter.vm.memory.utilization,block,optional"`
	VcenterVMNetworkPacketRate         MetricConfig `alloy:"vcenter.vm.network.packet.rate,block,optional"`
	VcenterVMNetworkPacketDropRate     MetricConfig `alloy:"vcenter.vm.network.packet.drop.rate,block,optional"`
	VcenterVMNetworkThroughput         MetricConfig `alloy:"vcenter.vm.network.throughput,block,optional"`
	VcenterVMNetworkUsage              MetricConfig `alloy:"vcenter.vm.network.usage,block,optional"`
	VcenterVMVsanLatencyAvg            MetricConfig `alloy:"vcenter.vm.vsan.latency.avg,block,optional"`
	VcenterVMVsanOperations            MetricConfig `alloy:"vcenter.vm.vsan.operations,block,optional"`
	VcenterVMVsanThroughput            MetricConfig `alloy:"vcenter.vm.vsan.throughput,block,optional"`
}

func (*MetricsConfig) Convert

func (args *MetricsConfig) Convert() map[string]interface{}

func (*MetricsConfig) SetToDefault

func (args *MetricsConfig) SetToDefault()

type ResourceAttributeConfig

type ResourceAttributeConfig struct {
	Enabled bool `alloy:"enabled,attr"`
}

func (*ResourceAttributeConfig) Convert

func (r *ResourceAttributeConfig) Convert() map[string]interface{}

type ResourceAttributesConfig

type ResourceAttributesConfig struct {
	VcenterDatacenterName            ResourceAttributeConfig `alloy:"vcenter.datacenter.name,block,optional"`
	VcenterClusterName               ResourceAttributeConfig `alloy:"vcenter.cluster.name,block,optional"`
	VcenterDatastoreName             ResourceAttributeConfig `alloy:"vcenter.datastore.name,block,optional"`
	VcenterHostName                  ResourceAttributeConfig `alloy:"vcenter.host.name,block,optional"`
	VcenterResourcePoolInventoryPath ResourceAttributeConfig `alloy:"vcenter.resource_pool.inventory_path,block,optional"`
	VcenterResourcePoolName          ResourceAttributeConfig `alloy:"vcenter.resource_pool.name,block,optional"`
	VcenterVirtualAppInventoryPath   ResourceAttributeConfig `alloy:"vcenter.virtual_app.inventory_path,block,optional"`
	VcenterVirtualAppName            ResourceAttributeConfig `alloy:"vcenter.virtual_app.name,block,optional"`
	VcenterVMID                      ResourceAttributeConfig `alloy:"vcenter.vm.id,block,optional"`
	VcenterVMName                    ResourceAttributeConfig `alloy:"vcenter.vm.name,block,optional"`
	VcenterVMTemplateID              ResourceAttributeConfig `alloy:"vcenter.vm_template.id,block,optional"`
	VcenterVMTemplateName            ResourceAttributeConfig `alloy:"vcenter.vm_template.name,block,optional"`
}

func (*ResourceAttributesConfig) Convert

func (args *ResourceAttributesConfig) Convert() map[string]interface{}

func (*ResourceAttributesConfig) SetToDefault

func (args *ResourceAttributesConfig) SetToDefault()