zipkinexporter

README

Zipkin Exporter

Exports trace data to a Zipkin back-end.

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.

The following settings can be optionally configured:

• insecure (default = false): whether to enable client transport security for the exporter's connection.
• ca_file path to the CA cert. For a client this verifies the server certificate. Should only be used if insecure is set to true.
• cert_file path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to true.
• key_file path to the TLS key to use for TLS required connections. Should only be used if insecure is set to true.
• defaultservicename (default = ): What to name services missing this information.
• timeout (default = 5s): How long to wait until the connection is close.
• read_buffer_size (default = 0): ReadBufferSize for HTTP client.
• write_buffer_size (default = 512 * 1024): WriteBufferSize for HTTP client.

Example:

exporters:
zipkin:
 endpoint: "http://some.url:9411/api/v2/spans"

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

Documentation

Index

• func NewFactory() component.ExporterFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for Zipkin exporter.

Types

type Config

type Config struct {
	configmodels.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.

	// 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.