zipkinreceiver

README

Zipkin Receiver

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

Supported pipeline types: traces

Getting Started

All that is required to enable the Zipkin receiver is to include it in the receiver definitions.

receivers:
  zipkin:

The following settings are configurable:

• endpoint (default = 0.0.0.0:9411): host:port to which the receiver is going to receive data. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md.

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• gRPC settings including CORS
• TLS and mTLS settings
• Queuing, retry and timeout settings

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type Config
  • func (cfg *Config) Validate() error
• type ZipkinReceiver
  • func New(config *Config, nextConsumer consumer.Traces) (*ZipkinReceiver, error)
  • func (zr *ZipkinReceiver) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (zr *ZipkinReceiver) Shutdown(context.Context) error
  • func (zr *ZipkinReceiver) Start(_ 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 {
	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	// Configures the receiver server protocol.
	confighttp.HTTPServerSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	// If enabled the zipkin receiver will attempt to parse string tags/binary annotations into int/bool/float.
	// Disabled by default
	ParseStringTags bool `mapstructure:"parse_string_tags"`
}

Config defines configuration for Zipkin receiver.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

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.Traces) (*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(_ context.Context, host component.Host) error

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