metadata

Documentation

Index

• Variables
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type MetricSettings
• type MetricsBuilder
  • func NewMetricsBuilder(settings MetricsSettings, options ...metricBuilderOption) *MetricsBuilder
  • func (mb *MetricsBuilder) Emit(ro ...ResourceOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitForResource(ro ...ResourceOption)
  • func (mb *MetricsBuilder) RecordRabbitmqConsumerCountDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordRabbitmqMessageAcknowledgedDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordRabbitmqMessageCurrentDataPoint(ts pcommon.Timestamp, val int64, messageStateAttributeValue string)
  • func (mb *MetricsBuilder) RecordRabbitmqMessageDeliveredDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordRabbitmqMessageDroppedDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) RecordRabbitmqMessagePublishedDataPoint(ts pcommon.Timestamp, val int64)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type MetricsSettings
  • func DefaultMetricsSettings() MetricsSettings
• type ResourceOption
  • func WithRabbitmqNodeName(val string) ResourceOption
  • func WithRabbitmqQueueName(val string) ResourceOption
  • func WithRabbitmqVhostName(val string) ResourceOption

Variables

var A = Attributes

A is an alias for Attributes.

var AttributeMessageState = struct {
	Ready          string
	Unacknowledged string
}{
	"ready",
	"unacknowledged",
}

AttributeMessageState are the possible values that the attribute "message.state" can have.

var Attributes = struct {
	// MessageState (The state of messages in a queue.)
	MessageState string
}{
	"state",
}

Attributes contains the possible metric attributes that can be used.

Functions

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

type MetricSettings

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

MetricSettings provides common settings for a particular metric.

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 settings.

func NewMetricsBuilder

func NewMetricsBuilder(settings MetricsSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) Emit

func (mb *MetricsBuilder) Emit(ro ...ResourceOption) 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 settings, e.g. delta or cumulative.

func (*MetricsBuilder) EmitForResource

func (mb *MetricsBuilder) EmitForResource(ro ...ResourceOption)

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 ResourceOption arguments.

func (*MetricsBuilder) RecordRabbitmqConsumerCountDataPoint

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

RecordRabbitmqConsumerCountDataPoint adds a data point to rabbitmq.consumer.count metric.

func (*MetricsBuilder) RecordRabbitmqMessageAcknowledgedDataPoint

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

RecordRabbitmqMessageAcknowledgedDataPoint adds a data point to rabbitmq.message.acknowledged metric.

func (*MetricsBuilder) RecordRabbitmqMessageCurrentDataPoint

func (mb *MetricsBuilder) RecordRabbitmqMessageCurrentDataPoint(ts pcommon.Timestamp, val int64, messageStateAttributeValue string)

RecordRabbitmqMessageCurrentDataPoint adds a data point to rabbitmq.message.current metric.

func (*MetricsBuilder) RecordRabbitmqMessageDeliveredDataPoint

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

RecordRabbitmqMessageDeliveredDataPoint adds a data point to rabbitmq.message.delivered metric.

func (*MetricsBuilder) RecordRabbitmqMessageDroppedDataPoint

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

RecordRabbitmqMessageDroppedDataPoint adds a data point to rabbitmq.message.dropped metric.

func (*MetricsBuilder) RecordRabbitmqMessagePublishedDataPoint

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

RecordRabbitmqMessagePublishedDataPoint adds a data point to rabbitmq.message.published 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 MetricsSettings

type MetricsSettings struct {
	RabbitmqConsumerCount       MetricSettings `mapstructure:"rabbitmq.consumer.count"`
	RabbitmqMessageAcknowledged MetricSettings `mapstructure:"rabbitmq.message.acknowledged"`
	RabbitmqMessageCurrent      MetricSettings `mapstructure:"rabbitmq.message.current"`
	RabbitmqMessageDelivered    MetricSettings `mapstructure:"rabbitmq.message.delivered"`
	RabbitmqMessageDropped      MetricSettings `mapstructure:"rabbitmq.message.dropped"`
	RabbitmqMessagePublished    MetricSettings `mapstructure:"rabbitmq.message.published"`
}

MetricsSettings provides settings for rabbitmqreceiver metrics.

func DefaultMetricsSettings

func DefaultMetricsSettings() MetricsSettings

type ResourceOption

type ResourceOption func(pcommon.Resource)

ResourceOption applies changes to provided resource.

func WithRabbitmqNodeName

func WithRabbitmqNodeName(val string) ResourceOption

WithRabbitmqNodeName sets provided value as "rabbitmq.node.name" attribute for current resource.

func WithRabbitmqQueueName

func WithRabbitmqQueueName(val string) ResourceOption

WithRabbitmqQueueName sets provided value as "rabbitmq.queue.name" attribute for current resource.

func WithRabbitmqVhostName

func WithRabbitmqVhostName(val string) ResourceOption

WithRabbitmqVhostName sets provided value as "rabbitmq.vhost.name" attribute for current resource.