metadata

Documentation

Index

• func WithResourceAttributesSettings(ras ResourceAttributesSettings) metricBuilderOption
• func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption
• type MetricsBuilder
  • func NewMetricsBuilder(settings receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder
  • func (mb *MetricsBuilder) AddDataPoint(resourceId, metric, aggregation, unit string, ts pcommon.Timestamp, ...)
  • func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitAllMetrics(ils pmetric.ScopeMetrics)
  • func (mb *MetricsBuilder) EmitForResource(rmo ...ResourceMetricsOption)
  • func (mb *MetricsBuilder) Reset(options ...metricBuilderOption)
• type ResourceAttributeSettings
  • func (ras *ResourceAttributeSettings) Unmarshal(parser *confmap.Conf) error
• type ResourceAttributesSettings
  • func DefaultResourceAttributesSettings() ResourceAttributesSettings
• type ResourceMetricsOption
  • func WithAzureMonitorSubscriptionID(val string) ResourceMetricsOption
  • func WithAzureMonitorTenantID(val string) ResourceMetricsOption
  • func WithStartTimeOverride(start pcommon.Timestamp) ResourceMetricsOption

Functions

func WithResourceAttributesSettings

func WithResourceAttributesSettings(ras ResourceAttributesSettings) metricBuilderOption

WithResourceAttributesSettings sets ResourceAttributeSettings on the metrics builder.

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption

WithStartTime sets startTime on the metrics builder.

Types

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 receiver.CreateSettings, options ...metricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) AddDataPoint

func (mb *MetricsBuilder) AddDataPoint(resourceId, metric, aggregation, unit string, ts pcommon.Timestamp, val float64)

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 settings, e.g. delta or cumulative.

func (*MetricsBuilder) EmitAllMetrics

func (mb *MetricsBuilder) EmitAllMetrics(ils pmetric.ScopeMetrics)

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

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

ResourceAttributeSettings provides common settings for a particular metric.

func (*ResourceAttributeSettings) Unmarshal

func (ras *ResourceAttributeSettings) Unmarshal(parser *confmap.Conf) error

type ResourceAttributesSettings

type ResourceAttributesSettings struct {
	AzureMonitorSubscriptionID ResourceAttributeSettings `mapstructure:"azuremonitor.subscription_id"`
	AzureMonitorTenantID       ResourceAttributeSettings `mapstructure:"azuremonitor.tenant_id"`
}

ResourceAttributesSettings provides settings for azuremonitorreceiver metrics.

func DefaultResourceAttributesSettings

func DefaultResourceAttributesSettings() ResourceAttributesSettings

type ResourceMetricsOption

type ResourceMetricsOption func(ResourceAttributesSettings, pmetric.ResourceMetrics)

ResourceMetricsOption applies changes to provided resource metrics.

func WithAzureMonitorSubscriptionID

func WithAzureMonitorSubscriptionID(val string) ResourceMetricsOption

WithAzureMonitorSubscriptionID sets provided value as "azuremonitor.subscription_id" attribute for current resource.

func WithAzureMonitorTenantID

func WithAzureMonitorTenantID(val string) ResourceMetricsOption

WithAzuremonitorTenantID sets provided value as "azuremonitor.tenant_id" attribute for current 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.