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() []pdata.Logs
  • func (bc LogsSink) Capabilities() consumer.Capabilities
  • func (sle *LogsSink) ConsumeLogs(_ context.Context, ld pdata.Logs) error
  • func (sle *LogsSink) LogRecordsCount() int
  • func (sle *LogsSink) Reset()
• type MetricsSink
  • func (sme *MetricsSink) AllMetrics() []pdata.Metrics
  • func (bc MetricsSink) Capabilities() consumer.Capabilities
  • func (sme *MetricsSink) ConsumeMetrics(_ context.Context, md pdata.Metrics) error
  • func (sme *MetricsSink) MetricsCount() int
  • func (sme *MetricsSink) Reset()
• type TracesSink
  • func (ste *TracesSink) AllTraces() []pdata.Traces
  • func (bc TracesSink) Capabilities() consumer.Capabilities
  • func (ste *TracesSink) ConsumeTraces(_ context.Context, td pdata.Traces) error
  • func (ste *TracesSink) Reset()
  • func (ste *TracesSink) SpansCount() 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, pdata.Traces) error
	// ConsumeMetrics to implement the consumer.Metrics.
	ConsumeMetrics(context.Context, pdata.Metrics) error
	// ConsumeLogs to implement the consumer.Logs.
	ConsumeLogs(context.Context, pdata.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 to implement it, to allow us to add extra functions without breaking compatibility because nobody else implements this interface.

func NewErr

func NewErr(err error) Consumer

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

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() []pdata.Logs

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

func (LogsSink) Capabilities

func (bc LogsSink) Capabilities() consumer.Capabilities

func (*LogsSink) ConsumeLogs

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

ConsumeLogs stores logs to this sink.

func (*LogsSink) LogRecordsCount

func (sle *LogsSink) LogRecordsCount() int

LogRecordsCount return 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() []pdata.Metrics

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

func (MetricsSink) Capabilities

func (bc MetricsSink) Capabilities() consumer.Capabilities

func (*MetricsSink) ConsumeMetrics

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

ConsumeMetrics stores metrics to this sink.

func (*MetricsSink) MetricsCount

func (sme *MetricsSink) MetricsCount() int

MetricsCount return 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() []pdata.Traces

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

func (TracesSink) Capabilities

func (bc TracesSink) Capabilities() consumer.Capabilities

func (*TracesSink) ConsumeTraces

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

ConsumeTraces stores traces to this sink.

func (*TracesSink) Reset

func (ste *TracesSink) Reset()

Reset deletes any stored data.

func (*TracesSink) SpansCount

func (ste *TracesSink) SpansCount() int

SpansCount return the number of spans sent to this sink.