zipkinscribereceiver

README

Zipkin Receiver

To be added.

Documentation

Overview

Package zipkinscribereceiver implements a receiver that can be used by the Opentelemetry collector to receive traces in the Zipkin-Scribe format.

Index

• func New(addr string, category string, nextConsumer consumer.TraceConsumerOld) (component.TraceReceiver, error)
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Receiver
  • func (f *Factory) CreateMetricsReceiver(ctx context.Context, logger *zap.Logger, cfg configmodels.Receiver, ...) (component.MetricsReceiver, error)
  • func (f *Factory) CreateTraceReceiver(ctx context.Context, logger *zap.Logger, cfg configmodels.Receiver, ...) (component.TraceReceiver, error)
  • func (f *Factory) CustomUnmarshaler() component.CustomUnmarshaler
  • func (f *Factory) Type() configmodels.Type

Functions

func New

func New(
	addr string,
	category string,
	nextConsumer consumer.TraceConsumerOld) (component.TraceReceiver, error)

New creates the Zipkin Scribe receiver with the given parameters.

Types

type Config

type Config struct {
	configmodels.ReceiverSettings `mapstructure:",squash"`

	// TODO: Use one of the configs from core.
	// The target endpoint.
	Endpoint string `mapstructure:"endpoint"`

	// Category is the string that will be used to identify the scribe log
	// messages that contain Zipkin spans.
	Category string `mapstructure:"category"`
}

Config defines configuration for Zipkin-Scribe receiver.

type Factory

type Factory struct {
}

Factory is the factory for Zipkin-Scribe receiver.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() configmodels.Receiver

CreateDefaultConfig creates the default configuration for Jaeger receiver.

func (*Factory) CreateMetricsReceiver

func (f *Factory) CreateMetricsReceiver(
	ctx context.Context,
	logger *zap.Logger,
	cfg configmodels.Receiver,
	consumer consumer.MetricsConsumerOld,
) (component.MetricsReceiver, error)

CreateMetricsReceiver creates a metrics receiver based on provided config.

func (*Factory) CreateTraceReceiver

func (f *Factory) CreateTraceReceiver(
	ctx context.Context,
	logger *zap.Logger,
	cfg configmodels.Receiver,
	nextConsumer consumer.TraceConsumerOld,
) (component.TraceReceiver, error)

CreateTraceReceiver creates a trace receiver based on provided config.

func (*Factory) CustomUnmarshaler

func (f *Factory) CustomUnmarshaler() component.CustomUnmarshaler

CustomUnmarshaler returns nil because we don't need custom unmarshaling for this config.

func (*Factory) Type

func (f *Factory) Type() configmodels.Type

Type gets the type of the Receiver config created by this factory.