zipkinexporter

README

Zipkin Exporter

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

Supported pipeline types: traces

Getting Started

The following settings are required:

• endpoint (no default): URL to which the exporter is going to send Zipkin trace data.
• format (default = JSON): The format to sent events in. Can be set to JSON or proto.

By default, TLS is enabled:

• insecure (default = false): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required:

• cert_file (no default): path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
• key_file (no default): path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.

The following settings are optional:

• defaultservicename (default = <missing service name>): What to name services missing this information.

Example:

exporters:
  zipkin:
    endpoint: "http://some.url:9411/api/v2/spans"
    cert_file: file.cert
    key_file: file.key
  zipkin/2:
    endpoint: "http://some.url:9411/api/v2/spans"
    insecure: true

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

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

Documentation

Overview

Package zipkinexporter exports trace data to Zipkin.

Index

• func NewFactory() component.ExporterFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for Zipkin exporter.

Types

type Config

type Config struct {
	config.ExporterSettings      `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	exporterhelper.QueueSettings `mapstructure:"sending_queue"`
	exporterhelper.RetrySettings `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.HTTPClientSettings `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