metadata

Documentation

Index

• Constants
• Variables
• type MetricBuilderOption
  • func WithStartTime(startTime pcommon.Timestamp) MetricBuilderOption
• type MetricsBuilder
  • func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.Settings, ...) *MetricsBuilder
  • func (mb *MetricsBuilder) AddDataPoint(resourceID, metric, aggregation, unit string, attributes map[string]*string, ...)
  • func (mb *MetricsBuilder) Emit(rmo ...ResourceMetricsOption) pmetric.Metrics
  • func (mb *MetricsBuilder) EmitAllMetrics(ils pmetric.ScopeMetrics)
  • func (mb *MetricsBuilder) EmitForResource(options ...ResourceMetricsOption)
  • func (mb *MetricsBuilder) NewResourceBuilder() *ResourceBuilder
  • func (mb *MetricsBuilder) Reset(options ...MetricBuilderOption)
• type MetricsBuilderConfig
  • func DefaultMetricsBuilderConfig() MetricsBuilderConfig
• type ResourceAttributeConfig
  • func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error
• type ResourceAttributesConfig
  • func DefaultResourceAttributesConfig() ResourceAttributesConfig
• type ResourceBuilder
  • func NewResourceBuilder(rac ResourceAttributesConfig) *ResourceBuilder
  • func (rb *ResourceBuilder) Emit() pcommon.Resource
  • func (rb *ResourceBuilder) SetAzuremonitorSubscription(val string)
  • func (rb *ResourceBuilder) SetAzuremonitorSubscriptionID(val string)
  • func (rb *ResourceBuilder) SetAzuremonitorTenantID(val string)
• type ResourceMetricsOption
  • func WithResource(res pcommon.Resource) ResourceMetricsOption

Constants

const (
	MetricsStability = component.StabilityLevelAlpha
)

Variables

var (
	Type      = component.MustNewType("azuremonitor")
	ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/azuremonitorreceiver"
)

Types

type MetricBuilderOption

type MetricBuilderOption interface {
	// contains filtered or unexported methods
}

MetricBuilderOption applies changes to default metrics builder.

func WithStartTime

func WithStartTime(startTime pcommon.Timestamp) MetricBuilderOption

WithStartTime sets startTime on the metrics builder.

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.Settings, options ...MetricBuilderOption) *MetricsBuilder

func (*MetricsBuilder) AddDataPoint

func (mb *MetricsBuilder) AddDataPoint(
	resourceID,
	metric,
	aggregation,
	unit string,
	attributes map[string]*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(options ...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) 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 {
	ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"`
}

MetricsBuilderConfig is a structural subset of an otherwise 1-1 copy of metadata.yaml

func DefaultMetricsBuilderConfig

func DefaultMetricsBuilderConfig() MetricsBuilderConfig

type ResourceAttributeConfig

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

ResourceAttributeConfig provides common config for a particular resource attribute.

func (*ResourceAttributeConfig) Unmarshal

func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error

type ResourceAttributesConfig

type ResourceAttributesConfig struct {
	AzuremonitorSubscription   ResourceAttributeConfig `mapstructure:"azuremonitor.subscription"`
	AzuremonitorSubscriptionID ResourceAttributeConfig `mapstructure:"azuremonitor.subscription_id"`
	AzuremonitorTenantID       ResourceAttributeConfig `mapstructure:"azuremonitor.tenant_id"`
}

ResourceAttributesConfig provides config for azuremonitor 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) SetAzuremonitorSubscription

func (rb *ResourceBuilder) SetAzuremonitorSubscription(val string)

SetAzuremonitorSubscription sets provided value as "azuremonitor.subscription" attribute.

func (*ResourceBuilder) SetAzuremonitorSubscriptionID

func (rb *ResourceBuilder) SetAzuremonitorSubscriptionID(val string)

SetAzuremonitorSubscriptionID sets provided value as "azuremonitor.subscription_id" attribute.

func (*ResourceBuilder) SetAzuremonitorTenantID

func (rb *ResourceBuilder) SetAzuremonitorTenantID(val string)

SetAzuremonitorTenantID sets provided value as "azuremonitor.tenant_id" attribute.

type ResourceMetricsOption

type ResourceMetricsOption interface {
	// contains filtered or unexported methods
}

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.