Documentation
¶
Overview ¶
Package consumer contains interfaces that receive and process data.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Capabilities ¶
type Capabilities struct {
// MutatesData is set to true if Consume* function of the
// processor modifies the input Traces, Logs or Metrics 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 ¶
ConsumeLogsFunc is a helper function that is similar to ConsumeLogs.
func (ConsumeLogsFunc) ConsumeLogs ¶
ConsumeLogs calls f(ctx, ld).
type ConsumeMetricsFunc ¶
ConsumeMetricsFunc is a helper function that is similar to ConsumeMetrics.
func (ConsumeMetricsFunc) ConsumeMetrics ¶
ConsumeMetrics calls f(ctx, md).
type ConsumeTracesFunc ¶
ConsumeTracesFunc is a helper function that is similar to ConsumeTraces.
func (ConsumeTracesFunc) ConsumeTraces ¶
ConsumeTraces calls f(ctx, td).
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.
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 an 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.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package consumererror provides wrappers to easily classify errors.
|
Package consumererror provides wrappers to easily classify errors. |
|
Package consumertest defines types and functions used to help test packages implementing the consumer package interfaces.
|
Package consumertest defines types and functions used to help test packages implementing the consumer package interfaces. |