processorhelper

Documentation

Index

• Variables
• func NewFactory(cfgType config.Type, createDefaultConfig CreateDefaultConfig, ...) component.ProcessorFactory
• func NewLogsProcessor(cfg config.Processor, nextConsumer consumer.Logs, logsFunc ProcessLogsFunc, ...) (component.LogsProcessor, error)
• func NewMetricsProcessor(cfg config.Processor, nextConsumer consumer.Metrics, ...) (component.MetricsProcessor, error)
• func NewTracesProcessor(cfg config.Processor, nextConsumer consumer.Traces, ...) (component.TracesProcessor, error)
• type CreateDefaultConfig
• type CreateLogsProcessor
• type CreateMetricsProcessor
• type CreateTracesProcessor
• type FactoryOption
  • func WithLogs(createLogsProcessor CreateLogsProcessor) FactoryOption
  • func WithMetrics(createMetricsProcessor CreateMetricsProcessor) FactoryOption
  • func WithTraces(createTracesProcessor CreateTracesProcessor) FactoryOption
• type Option
  • func WithCapabilities(capabilities consumer.Capabilities) Option
  • func WithShutdown(shutdown componenthelper.ShutdownFunc) Option
  • func WithStart(start componenthelper.StartFunc) Option
• type ProcessLogsFunc
• type ProcessMetricsFunc
• type ProcessTracesFunc

Variables

var ErrSkipProcessingData = errors.New("sentinel error to skip processing data from the remainder of the pipeline")

ErrSkipProcessingData is a sentinel value to indicate when traces or metrics should intentionally be dropped from further processing in the pipeline because the data is determined to be irrelevant. A processor can return this error to stop further processing without propagating an error back up the pipeline to logs.

Functions

func NewFactory

func NewFactory(
	cfgType config.Type,
	createDefaultConfig CreateDefaultConfig,
	options ...FactoryOption) component.ProcessorFactory

NewFactory returns a component.ProcessorFactory.

func NewLogsProcessor

func NewLogsProcessor(
	cfg config.Processor,
	nextConsumer consumer.Logs,
	logsFunc ProcessLogsFunc,
	options ...Option,
) (component.LogsProcessor, error)

NewLogsProcessor creates a LogsProcessor that ensure context propagation and the right tags are set. TODO: Add observability metrics support

func NewMetricsProcessor

func NewMetricsProcessor(
	cfg config.Processor,
	nextConsumer consumer.Metrics,
	metricsFunc ProcessMetricsFunc,
	options ...Option,
) (component.MetricsProcessor, error)

NewMetricsProcessor creates a MetricsProcessor that ensure context propagation and the right tags are set. TODO: Add observability metrics support

func NewTracesProcessor

func NewTracesProcessor(
	cfg config.Processor,
	nextConsumer consumer.Traces,
	tracesFunc ProcessTracesFunc,
	options ...Option,
) (component.TracesProcessor, error)

NewTracesProcessor creates a TracesProcessor that ensure context propagation and the right tags are set. TODO: Add observability metrics support

Types

type CreateDefaultConfig

type CreateDefaultConfig func() config.Processor

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

type CreateLogsProcessor

type CreateLogsProcessor func(context.Context, component.ProcessorCreateSettings, config.Processor, consumer.Logs) (component.LogsProcessor, error)

CreateLogsProcessor is the equivalent of component.ProcessorFactory.CreateLogsProcessor()

type CreateMetricsProcessor

type CreateMetricsProcessor func(context.Context, component.ProcessorCreateSettings, config.Processor, consumer.Metrics) (component.MetricsProcessor, error)

CreateMetricsProcessor is the equivalent of component.ProcessorFactory.CreateMetricsProcessor()

type CreateTracesProcessor

type CreateTracesProcessor func(context.Context, component.ProcessorCreateSettings, config.Processor, consumer.Traces) (component.TracesProcessor, error)

CreateTracesProcessor is the equivalent of component.ProcessorFactory.CreateTracesProcessor()

type FactoryOption

type FactoryOption func(o *factory)

FactoryOption apply changes to ProcessorOptions.

func WithLogs

func WithLogs(createLogsProcessor CreateLogsProcessor) FactoryOption

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

func WithMetrics

func WithMetrics(createMetricsProcessor CreateMetricsProcessor) FactoryOption

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

func WithTraces

func WithTraces(createTracesProcessor CreateTracesProcessor) FactoryOption

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

type Option

type Option func(*baseSettings)

Option apply changes to internalOptions.

func WithCapabilities

func WithCapabilities(capabilities consumer.Capabilities) Option

WithCapabilities overrides the default GetCapabilities function for an processor. The default GetCapabilities function returns mutable capabilities.

func WithShutdown

func WithShutdown(shutdown componenthelper.ShutdownFunc) Option

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

func WithStart

func WithStart(start componenthelper.StartFunc) Option

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

type ProcessLogsFunc

type ProcessLogsFunc func(context.Context, pdata.Logs) (pdata.Logs, error)

ProcessLogsFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.

type ProcessMetricsFunc

type ProcessMetricsFunc func(context.Context, pdata.Metrics) (pdata.Metrics, error)

ProcessMetricsFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.

type ProcessTracesFunc

type ProcessTracesFunc func(context.Context, pdata.Traces) (pdata.Traces, error)

ProcessTracesFunc is a helper function that processes the incoming data and returns the data to be sent to the next component. If error is returned then returned data are ignored. It MUST not call the next component.