internal

Documentation

Index

• Constants
• func NewThrottleRetry(err error, delay time.Duration) error
• type BaseExporter
  • func NewBaseExporter(set exporter.Settings, signal pipeline.Signal, options ...Option) (*BaseExporter, error)
  • func (be *BaseExporter) Send(ctx context.Context, req request.Request) error
  • func (be *BaseExporter) Shutdown(ctx context.Context) error
  • func (be *BaseExporter) Start(ctx context.Context, host component.Host) error
• type MockHost
  • func (nh *MockHost) GetExtensions() map[component.ID]component.Component
• type Option
  • func WithBatcher(cfg exporterbatcher.Config) Option
  • func WithCapabilities(capabilities consumer.Capabilities) Option
  • func WithEncoding(encoding exporterqueue.Encoding[request.Request]) Option
  • func WithQueue(cfg exporterqueue.Config) Option
  • func WithRequestQueue(cfg exporterqueue.Config, encoding exporterqueue.Encoding[request.Request]) Option
  • func WithRetry(config configretry.BackOffConfig) Option
  • func WithShutdown(shutdown component.ShutdownFunc) Option
  • func WithStart(start component.StartFunc) Option
  • func WithTimeout(timeoutConfig TimeoutConfig) Option
• type QueueSender
  • func NewQueueSender(qSet exporterqueue.Settings[request.Request], qCfg exporterqueue.Config, ...) (*QueueSender, error)
  • func (qs *QueueSender) Send(ctx context.Context, req request.Request) error
  • func (qs *QueueSender) Shutdown(ctx context.Context) error
  • func (qs *QueueSender) Start(ctx context.Context, host component.Host) error
• type SendFunc
• type Sender
• type TimeoutConfig
  • func NewDefaultTimeoutConfig() TimeoutConfig
  • func (ts *TimeoutConfig) Validate() error

Constants

const (

	// ExporterKey used to identify exporters in metrics and traces.
	ExporterKey = "exporter"

	// DataTypeKey used to identify the data type in the queue size metric.
	DataTypeKey = "data_type"

	// ItemsSent used to track number of items sent by exporters.
	ItemsSent = "items.sent"
	// ItemsFailed used to track number of items that failed to be sent by exporters.
	ItemsFailed = "items.failed"
)

Functions

func NewThrottleRetry

func NewThrottleRetry(err error, delay time.Duration) error

NewThrottleRetry creates a new throttle retry error.

Types

type BaseExporter

type BaseExporter struct {
	component.StartFunc
	component.ShutdownFunc

	Set exporter.Settings

	// Message for the user to be added with an export failure message.
	ExportFailureMessage string

	// Chain of senders that the exporter helper applies before passing the data to the actual exporter.
	// The data is handled by each sender in the respective order starting from the queueSender.
	// Most of the senders are optional, and initialized with a no-op path-through sender.
	QueueSender Sender[request.Request]
	RetrySender Sender[request.Request]

	ConsumerOptions []consumer.Option
	// contains filtered or unexported fields
}

func NewBaseExporter

func NewBaseExporter(set exporter.Settings, signal pipeline.Signal, options ...Option) (*BaseExporter, error)

func (*BaseExporter) Send

func (be *BaseExporter) Send(ctx context.Context, req request.Request) error

Send sends the request using the first sender in the chain.

func (*BaseExporter) Shutdown

func (be *BaseExporter) Shutdown(ctx context.Context) error

func (*BaseExporter) Start

func (be *BaseExporter) Start(ctx context.Context, host component.Host) error

type MockHost

type MockHost struct {
	component.Host
	Ext map[component.ID]component.Component
}

func (*MockHost) GetExtensions

func (nh *MockHost) GetExtensions() map[component.ID]component.Component

type Option

type Option func(*BaseExporter) error

Option apply changes to BaseExporter.

func WithBatcher

func WithBatcher(cfg exporterbatcher.Config) Option

WithBatcher enables batching for an exporter based on custom request types. For now, it can be used only with the New[Traces|Metrics|Logs]RequestExporter exporter helpers and WithRequestBatchFuncs provided. This API is at the early stage of development and may change without backward compatibility until https://github.com/open-telemetry/opentelemetry-collector/issues/8122 is resolved.

func WithCapabilities

func WithCapabilities(capabilities consumer.Capabilities) Option

WithCapabilities overrides the default Capabilities() function for a Consumer. The default is non-mutable data. TODO: Verify if we can change the default to be mutable as we do for processors.

func WithEncoding

func WithEncoding(encoding exporterqueue.Encoding[request.Request]) Option

WithEncoding is used to set the request encoding for the new exporter helper. It must be provided as the first option when creating a new exporter helper.

func WithQueue

func WithQueue(cfg exporterqueue.Config) Option

WithQueue overrides the default QueueConfig for an exporter. The default QueueConfig is to disable queueing. This option cannot be used with the new exporter helpers New[Traces|Metrics|Logs]RequestExporter.

func WithRequestQueue

func WithRequestQueue(cfg exporterqueue.Config, encoding exporterqueue.Encoding[request.Request]) Option

WithRequestQueue enables queueing for an exporter. This option should be used with the new exporter helpers New[Traces|Metrics|Logs]RequestExporter. Experimental: This API is at the early stage of development and may change without backward compatibility until https://github.com/open-telemetry/opentelemetry-collector/issues/8122 is resolved.

func WithRetry

func WithRetry(config configretry.BackOffConfig) Option

WithRetry overrides the default configretry.BackOffConfig for an exporter. The default configretry.BackOffConfig is to disable retries.

func WithShutdown

func WithShutdown(shutdown component.ShutdownFunc) Option

WithShutdown overrides the default Shutdown function for an exporter. The default shutdown function does nothing and always returns nil.

func WithStart

func WithStart(start component.StartFunc) Option

WithStart overrides the default Start function for an exporter. The default start function does nothing and always returns nil.

func WithTimeout

func WithTimeout(timeoutConfig TimeoutConfig) Option

WithTimeout overrides the default TimeoutConfig for an exporter. The default TimeoutConfig is 5 seconds.

type QueueSender

type QueueSender struct {
	// contains filtered or unexported fields
}

func NewQueueSender

func NewQueueSender(
	qSet exporterqueue.Settings[request.Request],
	qCfg exporterqueue.Config,
	bCfg exporterbatcher.Config,
	exportFailureMessage string,
	next Sender[request.Request],
) (*QueueSender, error)

func (*QueueSender) Send

func (qs *QueueSender) Send(ctx context.Context, req request.Request) error

Send implements the requestSender interface. It puts the request in the queue.

func (*QueueSender) Shutdown

func (qs *QueueSender) Shutdown(ctx context.Context) error

Shutdown is invoked during service shutdown.

func (*QueueSender) Start

func (qs *QueueSender) Start(ctx context.Context, host component.Host) error

Start is invoked during service startup.

type SendFunc

type SendFunc[K any] func(ctx context.Context, data K) error

type Sender

type Sender[K any] interface {
	component.Component
	Send(context.Context, K) error
}

type TimeoutConfig

type TimeoutConfig struct {
	// Timeout is the timeout for every attempt to send data to the backend.
	// A zero timeout means no timeout.
	Timeout time.Duration `mapstructure:"timeout"`
}

TimeoutConfig for timeout. The timeout applies to individual attempts to send data to the backend.

func NewDefaultTimeoutConfig

func NewDefaultTimeoutConfig() TimeoutConfig

NewDefaultTimeoutConfig returns the default config for TimeoutConfig.

func (*TimeoutConfig) Validate

func (ts *TimeoutConfig) Validate() error