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

• func NewFactory() component.ReceiverFactory
• type Config
• type ZipkinReceiver
  • func New(config *Config, nextConsumer consumer.TraceConsumer) (*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

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a new Zipkin receiver factory

Types

type Config

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

	// Configures the receiver server protocol.
	confighttp.HTTPServerSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
}

Config defines configuration for Zipkin receiver.

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(config *Config, nextConsumer consumer.TraceConsumer) (*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.