jaegerexporter

README

Jaeger Exporter

Exports trace data to Jaeger collectors. The following settings are required:

• endpoint (no default): target to which the exporter is going to send Jaeger trace data, using the gRPC protocol. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md

The following settings can be optionally configured:

• cert_pem_file: certificate file for TLS credentials of gRPC client. Should only be used if insecure is set to false.
• keepalive: keepalive parameters for client gRPC. See grpc.WithKeepaliveParams().
• insecure: whether to disable client transport security for the exporter's gRPC connection. See grpc.WithInsecure().
• server_name_override: If set to a non empty string, it will override the virtual host name of authority (e.g. :authority header field) in requests (typically used for testing).

Example:

exporters:
  jaeger:
    endpoint: jaeger-all-in-one:14250
    cert_pem_file: /my-cert.pem
    server_name_override: opentelemetry.io

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

Documentation

Overview

Package jaegerexporter implements an exporter that sends trace data to a Jaeger collector gRPC endpoint.

Index

• func New(config *Config) (component.TraceExporter, error)
• type Config
• type Factory
  • func (f *Factory) CreateDefaultConfig() configmodels.Exporter
  • func (f *Factory) CreateMetricsExporter(_ context.Context, _ component.ExporterCreateParams, _ configmodels.Exporter) (component.MetricsExporter, error)
  • func (f *Factory) CreateTraceExporter(_ context.Context, _ component.ExporterCreateParams, ...) (component.TraceExporter, error)
  • func (f *Factory) Type() configmodels.Type

Functions

func New

func New(config *Config) (component.TraceExporter, error)

New returns a new Jaeger gRPC exporter. The exporter name is the name to be used in the observability of the exporter. The collectorEndpoint should be of the form "hostname:14250" (a gRPC target).

Types

type Config

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

	configgrpc.GRPCClientSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
}

Config defines configuration for Jaeger gRPC exporter.

type Factory

type Factory struct {
}

Factory is the factory for Jaeger gRPC exporter.

func (*Factory) CreateDefaultConfig

func (f *Factory) CreateDefaultConfig() configmodels.Exporter

CreateDefaultConfig creates the default configuration for exporter.

func (*Factory) CreateMetricsExporter

func (f *Factory) CreateMetricsExporter(
	_ context.Context,
	_ component.ExporterCreateParams,
	_ configmodels.Exporter,
) (component.MetricsExporter, error)

CreateMetricsExporter creates a metrics exporter based on this config.

func (*Factory) CreateTraceExporter

func (f *Factory) CreateTraceExporter(
	_ context.Context,
	_ component.ExporterCreateParams,
	config configmodels.Exporter,
) (component.TraceExporter, error)

CreateTraceExporter creates a trace exporter based on this config.

func (*Factory) Type

func (f *Factory) Type() configmodels.Type

Type gets the type of the Exporter config created by this factory.