metadata

Documentation

Index

• Constants
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type MetricConfig
  • func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error
• type MetricsBuilder
  • func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, ...) *MetricsBuilder
  • func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)
  • func (mb *MetricsBuilder) NewResourceBuilder() *ResourceBuilder
  • func (mb *MetricsBuilder) RecordWireguardPeerNetworkIoUsageRxBytesDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordWireguardPeerNetworkIoUsageTxBytesDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type MetricsConfig
  • func DefaultMetricsConfig() MetricsConfig
• type ResourceAttributeConfig
• type ResourceAttributesConfig
  • func DefaultResourceAttributesConfig() ResourceAttributesConfig
• type ResourceBuilder
  • func NewResourceBuilder(rac ResourceAttributesConfig) *ResourceBuilder
  • func (rb *ResourceBuilder) Emit() pcommon.Resource
  • func (rb *ResourceBuilder) SetWireguardDeviceName(val string)
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeFreeBSDKernel()
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeLinuxKernel()
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeOpenBSDKernel()
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeUnknown()
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeUserspace()
  • func (rb *ResourceBuilder) SetWireguardDeviceTypeWindowsKernel()
  • func (rb *ResourceBuilder) SetWireguardPeerName(val string)
• type ResourceMetricsOption
  • func WithResource(res pcommon.Resource) ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Constants

const (
	Type             = "wireguard_stats"
	MetricsStability = component.StabilityLevelDevelopment
)

Functions

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type MetricConfig

type MetricConfig struct {
	Enabled bool `mapstructure:"enabled"`
	// contains filtered or unexported fields
}

MetricConfig provides common config for a particular metric.

func (*MetricConfig) Unmarshal

func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error

type MetricsBuilder

type MetricsBuilder struct {
	// contains filtered or unexported fields
}

MetricsBuilder provides an interface for scrapers to report metrics while taking care of all the transformations required to produce metric representation defined in metadata and user config.

func NewMetricsBuilder

func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit

func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics

Emit returns all the metrics accumulated by the metrics builder and updates the internal state to be ready for recording another set of metrics. This function will be responsible for applying all the transformations required to produce metric representation defined in metadata and user config, e.g. delta or cumulative.

func (*MetricsBuilder) EmitForResource

func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)

EmitForResource saves all the generated metrics under a new resource and updates the internal state to be ready for recording another set of data points as part of another resource. This function can be helpful when one scraper needs to emit metrics from several resources. Otherwise calling this function is not required, just `Emit` function can be called instead. Resource attributes should be provided as ResourceMetricsOption arguments.

func (*MetricsBuilder) NewResourceBuilder

func (mb *MetricsBuilder) NewResourceBuilder() *ResourceBuilder

NewResourceBuilder returns a new resource builder that should be used to build a resource associated with for the emitted metrics.

func (*MetricsBuilder) RecordWireguardPeerNetworkIoUsageRxBytesDataPoint

func (mb *MetricsBuilder) RecordWireguardPeerNetworkIoUsageRxBytesDataPoint(ts pcommon.Timestamp, val int64)

RecordWireguardPeerNetworkIoUsageRxBytesDataPoint adds a data point to wireguard.peer.network.io.usage.rx_bytes metric.

func (*MetricsBuilder) RecordWireguardPeerNetworkIoUsageTxBytesDataPoint

func (mb *MetricsBuilder) RecordWireguardPeerNetworkIoUsageTxBytesDataPoint(ts pcommon.Timestamp, val int64)

RecordWireguardPeerNetworkIoUsageTxBytesDataPoint adds a data point to wireguard.peer.network.io.usage.tx_bytes metric.

func (*MetricsBuilder) Reset

func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)

Reset resets metrics builder to its initial state. It should be used when external metrics source is restarted, and metrics builder should update its startTime and reset it's internal state accordingly.

type MetricsBuilderConfig

type MetricsBuilderConfig struct {
	Metrics            MetricsConfig            `mapstructure:"metrics"`
	ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"`
}

MetricsBuilderConfig is a configuration for wireguard_stats metrics builder.

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig

type MetricsConfig struct {
	WireguardPeerNetworkIoUsageRxBytes MetricConfig `mapstructure:"wireguard.peer.network.io.usage.rx_bytes"`
	WireguardPeerNetworkIoUsageTxBytes MetricConfig `mapstructure:"wireguard.peer.network.io.usage.tx_bytes"`
}

MetricsConfig provides config for wireguard_stats metrics.

func DefaultMetricsConfig

func DefaultMetricsConfig() MetricsConfig

type ResourceAttributeConfig

type ResourceAttributeConfig struct {
	Enabled bool `mapstructure:"enabled"`
}

ResourceAttributeConfig provides common config for a particular resource attribute.

type ResourceAttributesConfig

type ResourceAttributesConfig struct {
	WireguardDeviceName ResourceAttributeConfig `mapstructure:"wireguard.device.name"`
	WireguardDeviceType ResourceAttributeConfig `mapstructure:"wireguard.device.type"`
	WireguardPeerName   ResourceAttributeConfig `mapstructure:"wireguard.peer.name"`
}

ResourceAttributesConfig provides config for wireguard_stats resource attributes.

func DefaultResourceAttributesConfig

func DefaultResourceAttributesConfig() ResourceAttributesConfig

type ResourceBuilder

type ResourceBuilder struct {
	// contains filtered or unexported fields
}

ResourceBuilder is a helper struct to build resources predefined in metadata.yaml. The ResourceBuilder is not thread-safe and must not to be used in multiple goroutines.

func NewResourceBuilder

func NewResourceBuilder(rac ResourceAttributesConfig) *ResourceBuilder

NewResourceBuilder creates a new ResourceBuilder. This method should be called on the start of the application.

func (*ResourceBuilder) Emit

func (rb *ResourceBuilder) Emit() pcommon.Resource

Emit returns the built resource and resets the internal builder state.

func (*ResourceBuilder) SetWireguardDeviceName

func (rb *ResourceBuilder) SetWireguardDeviceName(val string)

SetWireguardDeviceName sets provided value as "wireguard.device.name" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeFreeBSDKernel

func (rb *ResourceBuilder) SetWireguardDeviceTypeFreeBSDKernel()

SetWireguardDeviceTypeFreeBSDKernel sets "wireguard.device.type=FreeBSD kernel" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeLinuxKernel

func (rb *ResourceBuilder) SetWireguardDeviceTypeLinuxKernel()

SetWireguardDeviceTypeLinuxKernel sets "wireguard.device.type=Linux kernel" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeOpenBSDKernel

func (rb *ResourceBuilder) SetWireguardDeviceTypeOpenBSDKernel()

SetWireguardDeviceTypeOpenBSDKernel sets "wireguard.device.type=OpenBSD kernel" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeUnknown

func (rb *ResourceBuilder) SetWireguardDeviceTypeUnknown()

SetWireguardDeviceTypeUnknown sets "wireguard.device.type=unknown" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeUserspace

func (rb *ResourceBuilder) SetWireguardDeviceTypeUserspace()

SetWireguardDeviceTypeUserspace sets "wireguard.device.type=userspace" attribute.

func (*ResourceBuilder) SetWireguardDeviceTypeWindowsKernel

func (rb *ResourceBuilder) SetWireguardDeviceTypeWindowsKernel()

SetWireguardDeviceTypeWindowsKernel sets "wireguard.device.type=Windows kernel" attribute.

func (*ResourceBuilder) SetWireguardPeerName

func (rb *ResourceBuilder) SetWireguardPeerName(val string)

SetWireguardPeerName sets provided value as "wireguard.peer.name" attribute.

type ResourceMetricsOption

type ResourceMetricsOption func(pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

func WithResource

func WithResource(res pcommon.Resource) ResourceMetricsOption

WithResource sets the provided resource on the emitted ResourceMetrics. It's recommended to use ResourceBuilder to create the resource.

func WithStartTimeOverride

func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

WithStartTimeOverride overrides start time for all the resource metrics data points. This option should be only used if different start time has to be set on metrics coming from different resources.