zipkinreceiver

README

Zipkin Receiver

This receiver receives spans from Zipkin (V1 and V2).

To get started, all that is required to enable the Zipkin receiver is to include it in the receiver definitions. This will enable the default values as specified here. The following is an example:

receivers:
  zipkin:

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

Documentation

Index

• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Receiver
  • func (f *Factory) CreateMetricsReceiver(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
• type ZipkinReceiver
  • func New(instanceName, address string, nextConsumer consumer.TraceConsumerOld) (*ZipkinReceiver, error)
  • func (zr *ZipkinReceiver) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (zr *ZipkinReceiver) Shutdown(context.Context) error
  • func (zr *ZipkinReceiver) Start(ctx context.Context, host component.Host) error
  • func (zr *ZipkinReceiver) WithHTTPServer(s *http.Server) *ZipkinReceiver

Types

type Config

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

Config defines configuration for Zipkin receiver.

type Factory

type Factory struct {
}

Factory is the factory for Zipkin 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(
	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.

type ZipkinReceiver

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

ZipkinReceiver type is used to handle spans received in the Zipkin format.

func New

func New(instanceName, address string, nextConsumer consumer.TraceConsumerOld) (*ZipkinReceiver, error)

New creates a new zipkinreceiver.ZipkinReceiver reference.

func (*ZipkinReceiver) ServeHTTP

func (zr *ZipkinReceiver) ServeHTTP(w http.ResponseWriter, r *http.Request)

The ZipkinReceiver receives spans from endpoint /api/v2 as JSON, unmarshals them and sends them along to the nextConsumer.

func (*ZipkinReceiver) Shutdown

func (zr *ZipkinReceiver) Shutdown(context.Context) error

Shutdown tells the receiver that should stop reception, giving it a chance to perform any necessary clean-up and shutting down its HTTP server.

func (*ZipkinReceiver) Start

func (zr *ZipkinReceiver) Start(ctx context.Context, host component.Host) error

Start spins up the receiver's HTTP server and makes the receiver start its processing.

func (*ZipkinReceiver) WithHTTPServer

func (zr *ZipkinReceiver) WithHTTPServer(s *http.Server) *ZipkinReceiver