testcomponents

Documentation

Index

• Variables
• func ExampleComponents() (factories component.Factories, err error)
• func NewDefaultFactories() (component.Factories, error)
• type ExampleExporter
  • func (cfg *ExampleExporter) Unmarshal(componentParser *config.Map) error
• type ExampleExporterConsumer
  • func (exp *ExampleExporterConsumer) Capabilities() consumer.Capabilities
  • func (exp *ExampleExporterConsumer) ConsumeLogs(_ context.Context, ld plog.Logs) error
  • func (exp *ExampleExporterConsumer) ConsumeMetrics(_ context.Context, md pmetric.Metrics) error
  • func (exp *ExampleExporterConsumer) ConsumeTraces(_ context.Context, td ptrace.Traces) error
  • func (exp *ExampleExporterConsumer) Shutdown(context.Context) error
  • func (exp *ExampleExporterConsumer) Start(_ context.Context, _ component.Host) error
• type ExampleExtensionCfg
• type ExampleProcessorCfg
• type ExampleReceiver
• type ExampleReceiverProducer
  • func (erp *ExampleReceiverProducer) Shutdown(context.Context) error
  • func (erp *ExampleReceiverProducer) Start(_ context.Context, _ component.Host) error

Variables

var ExampleExporterFactory = component.NewExporterFactory(
	expType,
	createExporterDefaultConfig,
	component.WithTracesExporter(createTracesExporter),
	component.WithMetricsExporter(createMetricsExporter),
	component.WithLogsExporter(createLogsExporter))

ExampleExporterFactory is factory for ExampleExporter.

var ExampleExtensionFactory = component.NewExtensionFactory(
	extType,
	createExtensionDefaultConfig,
	func(context.Context, component.ExtensionCreateSettings, config.Extension) (component.Extension, error) {
		return &extension{}, nil
	})

ExampleExtensionFactory is factory for ExampleExtensionCfg.

var ExampleProcessorFactory = component.NewProcessorFactory(
	procType,
	createDefaultConfig,
	component.WithTracesProcessor(createTracesProcessor),
	component.WithMetricsProcessor(createMetricsProcessor),
	component.WithLogsProcessor(createLogsProcessor))

ExampleProcessorFactory is factory for exampleProcessor.

var ExampleReceiverFactory = component.NewReceiverFactory(
	receiverType,
	createReceiverDefaultConfig,
	component.WithTracesReceiver(createTracesReceiver),
	component.WithMetricsReceiver(createMetricsReceiver),
	component.WithLogsReceiver(createLogsReceiver))

ExampleReceiverFactory is factory for ExampleReceiver.

Functions

func ExampleComponents

func ExampleComponents() (
	factories component.Factories,
	err error,
)

ExampleComponents registers example factories. This is only used by tests.

func NewDefaultFactories

func NewDefaultFactories() (component.Factories, error)

NewDefaultFactories returns the set of components in "testdata/otelcol-config.yaml". This is only used by tests.

Types

type ExampleExporter

type ExampleExporter struct {
	config.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	ExtraInt                int32                    `mapstructure:"extra_int"`
	ExtraSetting            string                   `mapstructure:"extra"`
	ExtraMapSetting         map[string]string        `mapstructure:"extra_map"`
	ExtraListSetting        []string                 `mapstructure:"extra_list"`
}

ExampleExporter is for testing purposes. We are defining an example config and factory for "exampleexporter" exporter type.

func (*ExampleExporter) Unmarshal

func (cfg *ExampleExporter) Unmarshal(componentParser *config.Map) error

Unmarshal a config.Map data into the config struct

type ExampleExporterConsumer

type ExampleExporterConsumer struct {
	Traces           []ptrace.Traces
	Metrics          []pmetric.Metrics
	Logs             []plog.Logs
	ExporterStarted  bool
	ExporterShutdown bool
}

ExampleExporterConsumer stores consumed traces and metrics for testing purposes.

func (*ExampleExporterConsumer) Capabilities

func (exp *ExampleExporterConsumer) Capabilities() consumer.Capabilities

func (*ExampleExporterConsumer) ConsumeLogs

func (exp *ExampleExporterConsumer) ConsumeLogs(_ context.Context, ld plog.Logs) error

func (*ExampleExporterConsumer) ConsumeMetrics

func (exp *ExampleExporterConsumer) ConsumeMetrics(_ context.Context, md pmetric.Metrics) error

ConsumeMetrics receives pmetric.Metrics for processing by the Metrics.

func (*ExampleExporterConsumer) ConsumeTraces

func (exp *ExampleExporterConsumer) ConsumeTraces(_ context.Context, td ptrace.Traces) error

ConsumeTraces receives ptrace.Traces for processing by the consumer.Traces.

func (*ExampleExporterConsumer) Shutdown

func (exp *ExampleExporterConsumer) Shutdown(context.Context) error

Shutdown is invoked during shutdown.

func (*ExampleExporterConsumer) Start

func (exp *ExampleExporterConsumer) Start(_ context.Context, _ component.Host) error

Start tells the exporter to start. The exporter may prepare for exporting by connecting to the endpoint. Host parameter can be used for communicating with the host after Start() has already returned.

type ExampleExtensionCfg

type ExampleExtensionCfg struct {
	config.ExtensionSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	ExtraSetting             string                   `mapstructure:"extra"`
	ExtraMapSetting          map[string]string        `mapstructure:"extra_map"`
	ExtraListSetting         []string                 `mapstructure:"extra_list"`
}

ExampleExtensionCfg is for testing purposes. We are defining an example config and factory for "exampleextension" extension type.

type ExampleProcessorCfg

type ExampleProcessorCfg struct {
	config.ProcessorSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	ExtraSetting             string                   `mapstructure:"extra"`
	ExtraMapSetting          map[string]string        `mapstructure:"extra_map"`
	ExtraListSetting         []string                 `mapstructure:"extra_list"`
}

ExampleProcessorCfg is for testing purposes. We are defining an example config and factory for "exampleprocessor" processor type.

type ExampleReceiver

type ExampleReceiver struct {
	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	// Configures the receiver server protocol.
	confignet.TCPAddr `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct

	ExtraSetting     string            `mapstructure:"extra"`
	ExtraMapSetting  map[string]string `mapstructure:"extra_map"`
	ExtraListSetting []string          `mapstructure:"extra_list"`
}

ExampleReceiver is for testing purposes. We are defining an example config and factory for "examplereceiver" receiver type.

type ExampleReceiverProducer

type ExampleReceiverProducer struct {
	Started bool
	Stopped bool
	consumer.Traces
	consumer.Metrics
	consumer.Logs
}

ExampleReceiverProducer allows producing traces and metrics for testing purposes.

func (*ExampleReceiverProducer) Shutdown

func (erp *ExampleReceiverProducer) Shutdown(context.Context) error

Shutdown tells the receiver that should stop reception,

func (*ExampleReceiverProducer) Start

func (erp *ExampleReceiverProducer) Start(_ context.Context, _ component.Host) error

Start tells the receiver to start its processing.