metadata

Documentation

Index

• Variables
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type AttributeDirection
  • func (av AttributeDirection) 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) RecordSystemDiskIoDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemDiskIoTimeDataPoint(ts pcommon.Timestamp, val float64, deviceAttributeValue string)
  • func (mb *MetricsBuilder) RecordSystemDiskMergedDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemDiskOperationTimeDataPoint(ts pcommon.Timestamp, val float64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemDiskOperationsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string, ...)
  • func (mb *MetricsBuilder) RecordSystemDiskPendingOperationsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string)
  • func (mb *MetricsBuilder) RecordSystemDiskWeightedIoTimeDataPoint(ts pcommon.Timestamp, val float64, deviceAttributeValue string)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type MetricsConfig
  • func DefaultMetricsConfig() MetricsConfig
• type ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Variables

var MapAttributeDirection = map[string]AttributeDirection{
	"read":  AttributeDirectionRead,
	"write": AttributeDirectionWrite,
}

MapAttributeDirection is a helper map of string to AttributeDirection 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 (
	AttributeDirectionRead AttributeDirection
	AttributeDirectionWrite
)

func (AttributeDirection) String

func (av AttributeDirection) String() string

String returns the string representation of the AttributeDirection.

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

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

RecordSystemDiskIoDataPoint adds a data point to system.disk.io metric.

func (*MetricsBuilder) RecordSystemDiskIoTimeDataPoint

func (mb *MetricsBuilder) RecordSystemDiskIoTimeDataPoint(ts pcommon.Timestamp, val float64, deviceAttributeValue string)

RecordSystemDiskIoTimeDataPoint adds a data point to system.disk.io_time metric.

func (*MetricsBuilder) RecordSystemDiskMergedDataPoint

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

RecordSystemDiskMergedDataPoint adds a data point to system.disk.merged metric.

func (*MetricsBuilder) RecordSystemDiskOperationTimeDataPoint

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

RecordSystemDiskOperationTimeDataPoint adds a data point to system.disk.operation_time metric.

func (*MetricsBuilder) RecordSystemDiskOperationsDataPoint

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

RecordSystemDiskOperationsDataPoint adds a data point to system.disk.operations metric.

func (*MetricsBuilder) RecordSystemDiskPendingOperationsDataPoint

func (mb *MetricsBuilder) RecordSystemDiskPendingOperationsDataPoint(ts pcommon.Timestamp, val int64, deviceAttributeValue string)

RecordSystemDiskPendingOperationsDataPoint adds a data point to system.disk.pending_operations metric.

func (*MetricsBuilder) RecordSystemDiskWeightedIoTimeDataPoint

func (mb *MetricsBuilder) RecordSystemDiskWeightedIoTimeDataPoint(ts pcommon.Timestamp, val float64, deviceAttributeValue string)

RecordSystemDiskWeightedIoTimeDataPoint adds a data point to system.disk.weighted_io_time 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/disk metrics builder.

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type MetricsConfig

type MetricsConfig struct {
	SystemDiskIo                MetricConfig `mapstructure:"system.disk.io"`
	SystemDiskIoTime            MetricConfig `mapstructure:"system.disk.io_time"`
	SystemDiskMerged            MetricConfig `mapstructure:"system.disk.merged"`
	SystemDiskOperationTime     MetricConfig `mapstructure:"system.disk.operation_time"`
	SystemDiskOperations        MetricConfig `mapstructure:"system.disk.operations"`
	SystemDiskPendingOperations MetricConfig `mapstructure:"system.disk.pending_operations"`
	SystemDiskWeightedIoTime    MetricConfig `mapstructure:"system.disk.weighted_io_time"`
}

MetricsConfig provides config for hostmetricsreceiver/disk metrics.

func DefaultMetricsConfig

func DefaultMetricsConfig() MetricsConfig

type ResourceMetricsOption

type ResourceMetricsOption func(pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

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.