metadata

Documentation

Index

• Variables
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type AttributeDirection
  • func (av AttributeDirection) String() string
• type AttributeProtocol
  • func (av AttributeProtocol) String() string
• 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) RecordSystemNetworkConnectionsDataPoint(ts pcommon.Timestamp, val int64, protocolAttributeValue AttributeProtocol, ...)
  • func (mb *MetricsBuilder) RecordSystemNetworkConntrackCountDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordSystemNetworkConntrackMaxDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordSystemNetworkDroppedDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemNetworkErrorsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemNetworkIoDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemNetworkPacketsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type MetricsConfig
  • func DefaultMetricsConfig() MetricsConfig
• type ResourceMetricsOption
  • func WithResource(res pcommon.Resource) ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Variables

var MapAttributeDirection = map[string]AttributeDirection{
	"receive":  AttributeDirectionReceive,
	"transmit": AttributeDirectionTransmit,
}

MapAttributeDirection is a helper map of string to AttributeDirection attribute value.

var MapAttributeProtocol = map[string]AttributeProtocol{
	"tcp": AttributeProtocolTcp,
}

MapAttributeProtocol is a helper map of string to AttributeProtocol attribute value.

Functions

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type AttributeDirection

type AttributeDirection int

AttributeDirection specifies the a value direction attribute.

const (
	AttributeDirectionReceive AttributeDirection
	AttributeDirectionTransmit
)

func (AttributeDirection) String

func (av AttributeDirection) String() string

String returns the string representation of the AttributeDirection.

type AttributeProtocol

type AttributeProtocol int

AttributeProtocol specifies the a value protocol attribute.

const (
	AttributeProtocolTcp AttributeProtocol
)

func (AttributeProtocol) String

func (av AttributeProtocol) String() string

String returns the string representation of the AttributeProtocol.

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) RecordSystemNetworkConnectionsDataPoint

func (mb *MetricsBuilder) RecordSystemNetworkConnectionsDataPoint(ts pcommon.Timestamp, val int64, protocolAttributeValue AttributeProtocol, stateAttributeValue string)

RecordSystemNetworkConnectionsDataPoint adds a data point to system.network.connections metric.

func (*MetricsBuilder) RecordSystemNetworkConntrackCountDataPoint

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

RecordSystemNetworkConntrackCountDataPoint adds a data point to system.network.conntrack.count metric.

func (*MetricsBuilder) RecordSystemNetworkConntrackMaxDataPoint

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

RecordSystemNetworkConntrackMaxDataPoint adds a data point to system.network.conntrack.max metric.

func (*MetricsBuilder) RecordSystemNetworkDroppedDataPoint

func (mb *MetricsBuilder) RecordSystemNetworkDroppedDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, directionAttributeValue AttributeDirection)

RecordSystemNetworkDroppedDataPoint adds a data point to system.network.dropped metric.

func (*MetricsBuilder) RecordSystemNetworkErrorsDataPoint

func (mb *MetricsBuilder) RecordSystemNetworkErrorsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, directionAttributeValue AttributeDirection)

RecordSystemNetworkErrorsDataPoint adds a data point to system.network.errors metric.

func (*MetricsBuilder) RecordSystemNetworkIoDataPoint

func (mb *MetricsBuilder) RecordSystemNetworkIoDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, directionAttributeValue AttributeDirection)

RecordSystemNetworkIoDataPoint adds a data point to system.network.io metric.

func (*MetricsBuilder) RecordSystemNetworkPacketsDataPoint

func (mb *MetricsBuilder) RecordSystemNetworkPacketsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, directionAttributeValue AttributeDirection)

RecordSystemNetworkPacketsDataPoint adds a data point to system.network.packets 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"`
}

MetricsBuilderConfig is a configuration for hostmetricsreceiver/network metrics builder.

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig

type MetricsConfig struct {
	SystemNetworkConnections    MetricConfig `mapstructure:"system.network.connections"`
	SystemNetworkConntrackCount MetricConfig `mapstructure:"system.network.conntrack.count"`
	SystemNetworkConntrackMax   MetricConfig `mapstructure:"system.network.conntrack.max"`
	SystemNetworkDropped        MetricConfig `mapstructure:"system.network.dropped"`
	SystemNetworkErrors         MetricConfig `mapstructure:"system.network.errors"`
	SystemNetworkIo             MetricConfig `mapstructure:"system.network.io"`
	SystemNetworkPackets        MetricConfig `mapstructure:"system.network.packets"`
}

MetricsConfig provides config for hostmetricsreceiver/network metrics.

func DefaultMetricsConfig

func DefaultMetricsConfig() MetricsConfig

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.