processor

Documentation

Index

• Variables
• type Batch
• type Details
  • func (d Details) GetInboundTransport() InboundTransport
  • func (d Details) GetSpanFormat() SpanFormat
  • func (d Details) GetTenant() string
• type InboundTransport
• type SpanFormat
• type SpanProcessor
• type SpansV1
  • func (s SpansV1) GetSpans(v1 func([]*model.Span), _ func(ptrace.Traces))
• type SpansV2
  • func (s SpansV2) GetSpans(_ func([]*model.Span), v2 func(ptrace.Traces))

Variables

var ErrBusy = errors.New("server busy")

ErrBusy signalizes that processor cannot process incoming data

Types

type Batch

type Batch interface {
	// GetSpans delegates to the appropriate function based on the data model version.
	GetSpans(v1 func(spans []*model.Span), v2 func(traces ptrace.Traces))

	GetSpanFormat() SpanFormat
	GetInboundTransport() InboundTransport
	GetTenant() string
}

Batch is a batch of spans passed to the processor.

type Details

type Details struct {
	SpanFormat       SpanFormat
	InboundTransport InboundTransport
	Tenant           string
}

func (Details) GetInboundTransport

func (d Details) GetInboundTransport() InboundTransport

func (Details) GetSpanFormat

func (d Details) GetSpanFormat() SpanFormat

func (Details) GetTenant

func (d Details) GetTenant() string

type InboundTransport

type InboundTransport string

InboundTransport identifies the transport used to receive spans.

const (
	// GRPCTransport indicates spans received over gRPC.
	GRPCTransport InboundTransport = "grpc"
	// HTTPTransport indicates spans received over HTTP.
	HTTPTransport InboundTransport = "http"
	// UnknownTransport is the fallback/catch-all category.
	UnknownTransport InboundTransport = "unknown"
)

type SpanFormat

type SpanFormat string

SpanFormat identifies the data format in which the span was originally received.

const (
	// JaegerSpanFormat is for Jaeger Thrift spans.
	JaegerSpanFormat SpanFormat = "jaeger"
	// ZipkinSpanFormat is for Zipkin Thrift spans.
	ZipkinSpanFormat SpanFormat = "zipkin"
	// ProtoSpanFormat is for Jaeger protobuf Spans.
	ProtoSpanFormat SpanFormat = "proto"
	// OTLPSpanFormat is for OpenTelemetry OTLP format.
	OTLPSpanFormat SpanFormat = "otlp"
	// UnknownSpanFormat is the fallback/catch-all category.
	UnknownSpanFormat SpanFormat = "unknown"
)

type SpanProcessor

type SpanProcessor interface {
	// ProcessSpans processes spans and return with either a list of true/false success or an error
	ProcessSpans(spans Batch) ([]bool, error)
	io.Closer
}

SpanProcessor handles spans

type SpansV1

type SpansV1 struct {
	Spans []*model.Span
	Details
}

Spans is a batch of spans passed to the processor.

func (SpansV1) GetSpans

func (s SpansV1) GetSpans(v1 func([]*model.Span), _ func(ptrace.Traces))

type SpansV2

type SpansV2 struct {
	Traces ptrace.Traces
	Details
}

func (SpansV2) GetSpans

func (s SpansV2) GetSpans(_ func([]*model.Span), v2 func(ptrace.Traces))