consumertest

Documentation

Overview

Package consumertest defines types and functions used to help test packages implementing the consumer package interfaces.

Index

• type Consumer
  • func NewErr(err error) Consumer
  • func NewNop() Consumer
• type LogsSink
  • func (sle *LogsSink) AllLogs() []plog.Logs
  • func (bc LogsSink) Capabilities() consumer.Capabilities
  • func (sle *LogsSink) ConsumeLogs(_ context.Context, ld plog.Logs) error
  • func (sle *LogsSink) LogRecordCount() int
  • func (sle *LogsSink) Reset()
• type MetricsSink
  • func (sme *MetricsSink) AllMetrics() []pmetric.Metrics
  • func (bc MetricsSink) Capabilities() consumer.Capabilities
  • func (sme *MetricsSink) ConsumeMetrics(_ context.Context, md pmetric.Metrics) error
  • func (sme *MetricsSink) DataPointCount() int
  • func (sme *MetricsSink) Reset()
• type TracesSink
  • func (ste *TracesSink) AllTraces() []ptrace.Traces
  • func (bc TracesSink) Capabilities() consumer.Capabilities
  • func (ste *TracesSink) ConsumeTraces(_ context.Context, td ptrace.Traces) error
  • func (ste *TracesSink) Reset()
  • func (ste *TracesSink) SpanCount() int

Types

type Consumer

type Consumer interface {
	// Capabilities to implement the base consumer functionality.
	Capabilities() consumer.Capabilities
	// ConsumeTraces to implement the consumer.Traces.
	ConsumeTraces(context.Context, ptrace.Traces) error
	// ConsumeMetrics to implement the consumer.Metrics.
	ConsumeMetrics(context.Context, pmetric.Metrics) error
	// ConsumeLogs to implement the consumer.Logs.
	ConsumeLogs(context.Context, plog.Logs) error
	// contains filtered or unexported methods
}

Consumer is a convenience interface that implements all consumer interfaces. It has a private function on it to forbid external users from implementing it and, as a result, to allow us to add extra functions without breaking compatibility.

func NewErr

func NewErr(err error) Consumer

NewErr returns a Consumer that just drops all received data and returns the specified error to Consume* callers.

func NewNop

func NewNop() Consumer

NewNop returns a Consumer that just drops all received data and returns no error.

type LogsSink

type LogsSink struct {
	// contains filtered or unexported fields
}

LogsSink is a consumer.Logs that acts like a sink that stores all logs and allows querying them for testing.

func (*LogsSink) AllLogs

func (sle *LogsSink) AllLogs() []plog.Logs

AllLogs returns the logs stored by this sink since last Reset.

func (LogsSink) Capabilities

func (bc LogsSink) Capabilities() consumer.Capabilities

Capabilities returns the base consumer capabilities.

func (*LogsSink) ConsumeLogs

func (sle *LogsSink) ConsumeLogs(_ context.Context, ld plog.Logs) error

ConsumeLogs stores logs to this sink.

func (*LogsSink) LogRecordCount

func (sle *LogsSink) LogRecordCount() int

LogRecordCount returns the number of log records stored by this sink since last Reset.

func (*LogsSink) Reset

func (sle *LogsSink) Reset()

Reset deletes any stored data.

type MetricsSink

type MetricsSink struct {
	// contains filtered or unexported fields
}

MetricsSink is a consumer.Metrics that acts like a sink that stores all metrics and allows querying them for testing.

func (*MetricsSink) AllMetrics

func (sme *MetricsSink) AllMetrics() []pmetric.Metrics

AllMetrics returns the metrics stored by this sink since last Reset.

func (MetricsSink) Capabilities

func (bc MetricsSink) Capabilities() consumer.Capabilities

Capabilities returns the base consumer capabilities.

func (*MetricsSink) ConsumeMetrics

func (sme *MetricsSink) ConsumeMetrics(_ context.Context, md pmetric.Metrics) error

ConsumeMetrics stores metrics to this sink.

func (*MetricsSink) DataPointCount

func (sme *MetricsSink) DataPointCount() int

DataPointCount returns the number of metrics stored by this sink since last Reset.

func (*MetricsSink) Reset

func (sme *MetricsSink) Reset()

Reset deletes any stored data.

type TracesSink

type TracesSink struct {
	// contains filtered or unexported fields
}

TracesSink is a consumer.Traces that acts like a sink that stores all traces and allows querying them for testing.

func (*TracesSink) AllTraces

func (ste *TracesSink) AllTraces() []ptrace.Traces

AllTraces returns the traces stored by this sink since last Reset.

func (TracesSink) Capabilities

func (bc TracesSink) Capabilities() consumer.Capabilities

Capabilities returns the base consumer capabilities.

func (*TracesSink) ConsumeTraces

func (ste *TracesSink) ConsumeTraces(_ context.Context, td ptrace.Traces) error

ConsumeTraces stores traces to this sink.

func (*TracesSink) Reset

func (ste *TracesSink) Reset()

Reset deletes any stored data.

func (*TracesSink) SpanCount

func (ste *TracesSink) SpanCount() int

SpanCount returns the number of spans sent to this sink.