testcomponents

Documentation

Index

• Variables
• func ExampleComponents() (component.Factories, error)
• type ExampleExporter
  • func (exp *ExampleExporter) Capabilities() consumer.Capabilities
  • func (exp *ExampleExporter) ConsumeLogs(_ context.Context, ld plog.Logs) error
  • func (exp *ExampleExporter) ConsumeMetrics(_ context.Context, md pmetric.Metrics) error
  • func (exp *ExampleExporter) ConsumeTraces(_ context.Context, td ptrace.Traces) error
  • func (exp *ExampleExporter) Shutdown(context.Context) error
  • func (exp *ExampleExporter) Start(_ context.Context, _ component.Host) error
• type ExampleExporterConfig
• type ExampleProcessor
  • func (ep *ExampleProcessor) Capabilities() consumer.Capabilities
  • func (ep *ExampleProcessor) Shutdown(_ context.Context) error
  • func (ep *ExampleProcessor) Start(_ context.Context, _ component.Host) error
• type ExampleProcessorConfig
• type ExampleReceiver
  • func (erp *ExampleReceiver) Shutdown(context.Context) error
  • func (erp *ExampleReceiver) Start(_ context.Context, _ component.Host) error
• type ExampleReceiverConfig

Variables

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

ExampleExporterFactory is factory for ExampleExporter.

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

ExampleProcessorFactory is factory for ExampleProcessor.

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

ExampleReceiverFactory is factory for ExampleReceiver.

Functions

func ExampleComponents

func ExampleComponents() (component.Factories, error)

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

Types

type ExampleExporter

type ExampleExporter struct {
	Traces  []ptrace.Traces
	Metrics []pmetric.Metrics
	Logs    []plog.Logs
	Started bool
	Stopped bool
}

ExampleExporter stores consumed traces and metrics for testing purposes.

func (*ExampleExporter) Capabilities

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

func (*ExampleExporter) ConsumeLogs

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

func (*ExampleExporter) ConsumeMetrics

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

ConsumeMetrics receives pmetric.Metrics for processing by the Metrics.

func (*ExampleExporter) ConsumeTraces

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

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

func (*ExampleExporter) Shutdown

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

Shutdown is invoked during shutdown.

func (*ExampleExporter) Start

func (exp *ExampleExporter) 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 ExampleExporterConfig

type ExampleExporterConfig struct {
	config.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
}

ExampleExporterConfig config for ExampleExporter.

type ExampleProcessor

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

func (*ExampleProcessor) Capabilities

func (ep *ExampleProcessor) Capabilities() consumer.Capabilities

func (*ExampleProcessor) Shutdown

func (ep *ExampleProcessor) Shutdown(_ context.Context) error

func (*ExampleProcessor) Start

func (ep *ExampleProcessor) Start(_ context.Context, _ component.Host) error

type ExampleProcessorConfig

type ExampleProcessorConfig struct {
	config.ProcessorSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
}

ExampleProcessorConfig config for ExampleProcessor.

type ExampleReceiver

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

ExampleReceiver allows producing traces and metrics for testing purposes.

func (*ExampleReceiver) Shutdown

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

Shutdown tells the receiver that should stop reception,

func (*ExampleReceiver) Start

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

Start tells the receiver to start its processing.

type ExampleReceiverConfig

type ExampleReceiverConfig struct {
	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
}

ExampleReceiverConfig config for ExampleReceiver.