receiverhelper

Documentation

Index

• func NewFactory(cfgType configmodels.Type, createDefaultConfig CreateDefaultConfig, ...) component.ReceiverFactory
• func NewScraperControllerReceiver(cfg *ScraperControllerSettings, nextConsumer consumer.MetricsConsumer, ...) (component.Receiver, error)
• type BaseScraper
• type Close
• type CreateDefaultConfig
• type CreateLogsReceiver
• type CreateMetricsReceiver
• type CreateTraceReceiver
• type FactoryOption
  • func WithCustomUnmarshaler(customUnmarshaler component.CustomUnmarshaler) FactoryOption
  • func WithLogs(createLogsReceiver CreateLogsReceiver) FactoryOption
  • func WithMetrics(createMetricsReceiver CreateMetricsReceiver) FactoryOption
  • func WithTraces(createTraceReceiver CreateTraceReceiver) FactoryOption
• type Initialize
• type MetricsScraper
  • func NewMetricsScraper(scrape ScrapeMetrics, options ...ScraperOption) MetricsScraper
• type ResourceMetricsScraper
  • func NewResourceMetricsScraper(scrape ScrapeResourceMetrics, options ...ScraperOption) ResourceMetricsScraper
• type ScrapeMetrics
• type ScrapeResourceMetrics
• type ScraperControllerOption
  • func AddMetricsScraper(scraper MetricsScraper) ScraperControllerOption
  • func AddResourceMetricsScraper(scrape ResourceMetricsScraper) ScraperControllerOption
  • func WithTickerChannel(tickerCh <-chan time.Time) ScraperControllerOption
• type ScraperControllerSettings
  • func DefaultScraperControllerSettings(cfgType configmodels.Type) ScraperControllerSettings
• type ScraperOption
  • func WithClose(close Close) ScraperOption
  • func WithInitialize(initialize Initialize) ScraperOption

Functions

func NewFactory

func NewFactory(
	cfgType configmodels.Type,
	createDefaultConfig CreateDefaultConfig,
	options ...FactoryOption) component.ReceiverFactory

NewFactory returns a component.ReceiverFactory.

func NewScraperControllerReceiver

func NewScraperControllerReceiver(cfg *ScraperControllerSettings, nextConsumer consumer.MetricsConsumer, options ...ScraperControllerOption) (component.Receiver, error)

NewScraperControllerReceiver creates a Receiver with the configured options, that can control multiple scrapers.

Types

type BaseScraper

type BaseScraper interface {
	// Initialize performs any timely initialization tasks such as
	// setting up performance counters for initial collection.
	Initialize(ctx context.Context) error

	// Close should clean up any unmanaged resources such as
	// performance counter handles.
	Close(ctx context.Context) error
}

type Close

type Close func(ctx context.Context) error

Close should clean up any unmanaged resources such as performance counter handles.

type CreateDefaultConfig

type CreateDefaultConfig func() configmodels.Receiver

CreateDefaultConfig is the equivalent of component.ReceiverFactory.CreateDefaultConfig()

type CreateLogsReceiver

type CreateLogsReceiver func(context.Context, component.ReceiverCreateParams, configmodels.Receiver, consumer.LogsConsumer) (component.LogsReceiver, error)

CreateLogsReceiver is the equivalent of component.ReceiverFactory.CreateLogsReceiver()

type CreateMetricsReceiver

type CreateMetricsReceiver func(context.Context, component.ReceiverCreateParams, configmodels.Receiver, consumer.MetricsConsumer) (component.MetricsReceiver, error)

CreateMetricsReceiver is the equivalent of component.ReceiverFactory.CreateMetricsReceiver()

type CreateTraceReceiver

type CreateTraceReceiver func(context.Context, component.ReceiverCreateParams, configmodels.Receiver, consumer.TraceConsumer) (component.TraceReceiver, error)

CreateTraceReceiver is the equivalent of component.ReceiverFactory.CreateTraceReceiver()

type FactoryOption

type FactoryOption func(o *factory)

FactoryOption apply changes to ReceiverOptions.

func WithCustomUnmarshaler

func WithCustomUnmarshaler(customUnmarshaler component.CustomUnmarshaler) FactoryOption

WithCustomUnmarshaler implements component.ConfigUnmarshaler.

func WithLogs

func WithLogs(createLogsReceiver CreateLogsReceiver) FactoryOption

WithLogs overrides the default "error not supported" implementation for CreateLogsReceiver.

func WithMetrics

func WithMetrics(createMetricsReceiver CreateMetricsReceiver) FactoryOption

WithMetrics overrides the default "error not supported" implementation for CreateMetricsReceiver.

func WithTraces

func WithTraces(createTraceReceiver CreateTraceReceiver) FactoryOption

WithTraces overrides the default "error not supported" implementation for CreateTraceReceiver.

type Initialize

type Initialize func(ctx context.Context) error

Initialize performs any timely initialization tasks such as setting up performance counters for initial collection.

type MetricsScraper

type MetricsScraper interface {
	BaseScraper
	Scrape(context.Context) (pdata.MetricSlice, error)
}

MetricsScraper is an interface for scrapers that scrape metrics.

func NewMetricsScraper

func NewMetricsScraper(
	scrape ScrapeMetrics,
	options ...ScraperOption,
) MetricsScraper

NewMetricsScraper creates a Scraper that calls Scrape at the specified collection interval, reports observability information, and passes the scraped metrics to the next consumer.

type ResourceMetricsScraper

type ResourceMetricsScraper interface {
	BaseScraper
	Scrape(context.Context) (pdata.ResourceMetricsSlice, error)
}

ResourceMetricsScraper is an interface for scrapers that scrape resource metrics.

func NewResourceMetricsScraper

func NewResourceMetricsScraper(
	scrape ScrapeResourceMetrics,
	options ...ScraperOption,
) ResourceMetricsScraper

NewResourceMetricsScraper creates a Scraper that calls Scrape at the specified collection interval, reports observability information, and passes the scraped resource metrics to the next consumer.

type ScrapeMetrics

type ScrapeMetrics func(context.Context) (pdata.MetricSlice, error)

Scrape metrics.

type ScrapeResourceMetrics

type ScrapeResourceMetrics func(context.Context) (pdata.ResourceMetricsSlice, error)

Scrape resource metrics.

type ScraperControllerOption

type ScraperControllerOption func(*scraperController)

ScraperControllerOption apply changes to internal options.

func AddMetricsScraper

func AddMetricsScraper(scraper MetricsScraper) ScraperControllerOption

AddMetricsScraper configures the provided scrape function to be called with the specified options, and at the specified collection interval.

Observability information will be reported, and the scraped metrics will be passed to the next consumer.

func AddResourceMetricsScraper

func AddResourceMetricsScraper(scrape ResourceMetricsScraper) ScraperControllerOption

AddResourceMetricsScraper configures the provided scrape function to be called with the specified options, and at the specified collection interval.

Observability information will be reported, and the scraped resource metrics will be passed to the next consumer.

func WithTickerChannel

func WithTickerChannel(tickerCh <-chan time.Time) ScraperControllerOption

WithTickerChannel allows you to override the scraper controllers ticker channel to specify when scrape is called. This is only expected to be used by tests.

type ScraperControllerSettings

type ScraperControllerSettings struct {
	configmodels.ReceiverSettings `mapstructure:"squash"`
	CollectionInterval            time.Duration `mapstructure:"collection_interval"`
}

ScraperControllerSettings defines common settings for a scraper controller configuration. Scraper controller receivers can embed this struct, instead of configmodels.ReceiverSettings, and extend it with more fields if needed.

func DefaultScraperControllerSettings

func DefaultScraperControllerSettings(cfgType configmodels.Type) ScraperControllerSettings

DefaultScraperControllerSettings returns default scraper controller settings with a collection interval of one minute.

type ScraperOption

type ScraperOption func(*baseScraper)

ScraperOption apply changes to internal options.

func WithClose

func WithClose(close Close) ScraperOption

WithClose sets the function that will be called on shutdown.

func WithInitialize

func WithInitialize(initialize Initialize) ScraperOption

WithInitialize sets the function that will be called on startup.