consumertest

package
Version: v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2021 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Consumer added in v0.24.0

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 from implementing it and, as a result, to allow us to add extra functions without breaking compatibility.

func NewErr added in v0.24.0

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 added in v0.24.0

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 added in v0.27.0

func (bc LogsSink) Capabilities() consumer.Capabilities

Capabilities returns the base consumer capabilities.

func (*LogsSink) ConsumeLogs

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

ConsumeLogs stores logs to this sink.

func (*LogsSink) LogRecordCount added in v0.30.0

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

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

func (MetricsSink) Capabilities added in v0.27.0

func (bc MetricsSink) Capabilities() consumer.Capabilities

Capabilities returns the base consumer capabilities.

func (*MetricsSink) ConsumeMetrics

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

ConsumeMetrics stores metrics to this sink.

func (*MetricsSink) DataPointCount added in v0.30.0

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

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

func (TracesSink) Capabilities added in v0.27.0

func (bc TracesSink) Capabilities() consumer.Capabilities

Capabilities returns the base 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) SpanCount added in v0.30.0

func (ste *TracesSink) SpanCount() int

SpanCount returns the number of spans sent to this sink.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL