consumer

Documentation

Overview

Package consumer contains interfaces that receive and process consumerdata.

Index

• type Capabilities
• type ConsumeLogsFunc
  • func (f ConsumeLogsFunc) ConsumeLogs(ctx context.Context, ld plog.Logs) error
• type ConsumeMetricsFunc
  • func (f ConsumeMetricsFunc) ConsumeMetrics(ctx context.Context, ld pmetric.Metrics) error
• type ConsumeTracesFunc
  • func (f ConsumeTracesFunc) ConsumeTraces(ctx context.Context, ld ptrace.Traces) error
• type Logs
  • func NewLogs(consume ConsumeLogsFunc, options ...Option) (Logs, error)
• type Metrics
  • func NewMetrics(consume ConsumeMetricsFunc, options ...Option) (Metrics, error)
• type Option
  • func WithCapabilities(capabilities Capabilities) Option
• type Traces
  • func NewTraces(consume ConsumeTracesFunc, options ...Option) (Traces, error)

Types

type Capabilities

type Capabilities struct {
	// MutatesData is set to true if Consume* function of the
	// processor modifies the input TraceData or MetricsData argument.
	// Processors which modify the input data MUST set this flag to true. If the processor
	// does not modify the data it MUST set this flag to false. If the processor creates
	// a copy of the data before modifying then this flag can be safely set to false.
	MutatesData bool
}

Capabilities describes the capabilities of a Processor.

type ConsumeLogsFunc

type ConsumeLogsFunc func(ctx context.Context, ld plog.Logs) error

ConsumeLogsFunc is a helper function that is similar to ConsumeLogs.

func (ConsumeLogsFunc) ConsumeLogs

func (f ConsumeLogsFunc) ConsumeLogs(ctx context.Context, ld plog.Logs) error

ConsumeLogs calls f(ctx, ld).

type ConsumeMetricsFunc

type ConsumeMetricsFunc func(ctx context.Context, ld pmetric.Metrics) error

ConsumeMetricsFunc is a helper function that is similar to ConsumeMetrics.

func (ConsumeMetricsFunc) ConsumeMetrics

func (f ConsumeMetricsFunc) ConsumeMetrics(ctx context.Context, ld pmetric.Metrics) error

ConsumeMetrics calls f(ctx, ld).

type ConsumeTracesFunc

type ConsumeTracesFunc func(ctx context.Context, ld ptrace.Traces) error

ConsumeTracesFunc is a helper function that is similar to ConsumeTraces.

func (ConsumeTracesFunc) ConsumeTraces

func (f ConsumeTracesFunc) ConsumeTraces(ctx context.Context, ld ptrace.Traces) error

ConsumeTraces calls f(ctx, ld).

type Logs

type Logs interface {

	// ConsumeLogs receives plog.Logs for consumption.
	ConsumeLogs(ctx context.Context, ld plog.Logs) error
	// contains filtered or unexported methods
}

Logs is an interface that receives plog.Logs, processes it as needed, and sends it to the next processing node if any or to the destination.

func NewLogs

func NewLogs(consume ConsumeLogsFunc, options ...Option) (Logs, error)

NewLogs returns a Logs configured with the provided options.

type Metrics

type Metrics interface {

	// ConsumeMetrics receives pmetric.Metrics for consumption.
	ConsumeMetrics(ctx context.Context, md pmetric.Metrics) error
	// contains filtered or unexported methods
}

Metrics is the new metrics consumer interface that receives pmetric.Metrics, processes it as needed, and sends it to the next processing node if any or to the destination.

func NewMetrics

func NewMetrics(consume ConsumeMetricsFunc, options ...Option) (Metrics, error)

NewMetrics returns a Metrics configured with the provided options.

type Option

type Option func(*baseImpl)

Option to construct new consumers.

func WithCapabilities

func WithCapabilities(capabilities Capabilities) Option

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

type Traces

type Traces interface {

	// ConsumeTraces receives ptrace.Traces for consumption.
	ConsumeTraces(ctx context.Context, td ptrace.Traces) error
	// contains filtered or unexported methods
}

Traces is an interface that receives ptrace.Traces, processes it as needed, and sends it to the next processing node if any or to the destination.

func NewTraces

func NewTraces(consume ConsumeTracesFunc, options ...Option) (Traces, error)

NewTraces returns a Traces configured with the provided options.