zipkinexporter

README

Zipkin Exporter

Status
Stability	beta: traces
Distributions	core, contrib
Issues
Code coverage
Code Owners	@MovieStoreGuy, @andrzej-stencel, @crobert-1

Exports data to a Zipkin back-end. By default, this exporter requires TLS and offers queued retry capabilities.

Getting Started

The following settings are required:

• endpoint (no default): URL to which the exporter is going to send Zipkin trace data. For example: http://localhost:9411/api/v2/spans.

The following settings are optional:

• format (default = json): The format to sent events in. Can be set to json or proto.
• default_service_name (default = <missing service name>): What to name services missing this information.

To use TLS, specify https:// as the protocol scheme in the URL passed to the endpoint property. See Advanced Configuration for more TLS options.

Example:

exporters:
  zipkin/nontls:
    endpoint: "http://some.url:9411/api/v2/spans"
    format: proto
    default_service_name: unknown-service

  zipkin/withtls:
    endpoint: "https://some.url:9411/api/v2/spans"

  zipkin/tlsnoverify:
    endpoint: "https://some.url:9411/api/v2/spans"
    tls:
      insecure_skip_verify: true

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• HTTP client settings
• TLS and mTLS settings
• Queuing, retry and timeout settings

Documentation

Overview

Package zipkinexporter exports trace data to Zipkin.

Index

• func NewFactory() exporter.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for Zipkin exporter.

Types

type Config

type Config struct {
	QueueSettings             configoptional.Optional[exporterhelper.QueueBatchConfig] `mapstructure:"sending_queue"`
	configretry.BackOffConfig `mapstructure:"retry_on_failure"`

	// Configures the exporter client.
	// The Endpoint to send the Zipkin trace data to (e.g.: http://some.url:9411/api/v2/spans).
	confighttp.ClientConfig `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	Format string `mapstructure:"format"`

	DefaultServiceName string `mapstructure:"default_service_name"`
}

Config defines configuration settings for the Zipkin exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid