exporter

README

Exporters

Below is the list of exporters directly supported by the OpenTelemetry Service.

• Jaeger
• Logging
• OpenCensus
• Prometheus
• Zipkin

The contributors repository has more exporters that can be added to custom builds of the service.

Jaeger

Exports trace data to Jaeger collectors accepting one of the following protocols:

• gRPC

Configuration

Each different supported protocol has its own configuration settings.

gRPC

• endpoint: 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

Example:

exporters:
  jaeger-grpc:
    endpoint: jaeger-all-in-one:14250

Logging

TODO: document settings

OpenCensus

Exports traces and/or metrics to another OTel-Svc endpoint via gRPC.

Configuration

• endpoint: target to which the exporter is going to send traces or metrics, using the gRPC protocol. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md. Required.

• compression: compression key for supported compression types within collector. Currently the only supported mode is gzip. Optional.

• headers: the headers associated with gRPC requests. Optional.

• num-workers: number of workers that send the gRPC requests. Optional.

• secure: whether to enable client transport security for the exporter's gRPC connection. See grpc.WithInsecure(). Optional.

• cert-pem-file: certificate file for TLS credentials of gRPC client. Should only be used if secure is set to true. Optional.

• reconnection-delay: time period between each reconnection performed by the exporter. Optional.

• keepalive: keepalive parameters for client gRPC. See grpc.WithKeepaliveParams(). Optional.

Example:

exporters:
  opencensus:
    endpoint: 127.0.0.1:14250
    reconnection-delay: 60s
    secure: false

Prometheus

TODO: document settings

Zipkin

Exports trace data to a Zipkin back-end.

Configuration

The following settings can be configured:

• url: URL to which the exporter is going to send Zipkin trace data. This setting doesn't have a default value and must be specified in the configuration.

Example:

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

Documentation

Overview

Package exporter contains interfaces that wraps trace/metrics exporter.

Index

• func Build(factories ...Factory) (map[string]Factory, error)
• type Factory
• type MetricsExporter
• type StopFunc
• type TraceExporter

Functions

func Build

func Build(factories ...Factory) (map[string]Factory, error)

Build takes a list of exporter factories and returns a map of type map[string]Factory with factory type as keys. It returns a non-nil error when more than one factories have the same type.

Types

type Factory

type Factory interface {
	// Type gets the type of the Exporter created by this factory.
	Type() string

	// CreateDefaultConfig creates the default configuration for the Exporter.
	CreateDefaultConfig() configmodels.Exporter

	// CreateTraceExporter creates a trace exporter based on this config.
	CreateTraceExporter(logger *zap.Logger, cfg configmodels.Exporter) (consumer.TraceConsumer, StopFunc, error)

	// CreateMetricsExporter creates a metrics exporter based on this config.
	CreateMetricsExporter(logger *zap.Logger, cfg configmodels.Exporter) (consumer.MetricsConsumer, StopFunc, error)
}

Factory interface for exporters.

type MetricsExporter

type MetricsExporter interface {
	consumer.MetricsConsumer

	// Name gets the name of the metrics exporter.
	Name() string
}

MetricsExporter composes MetricsConsumer with some additional exporter-specific functions.

type StopFunc

type StopFunc func() error

StopFunc is a function that can be called to stop an exporter that was created previously.

type TraceExporter

type TraceExporter interface {
	consumer.TraceConsumer

	// Name gets the name of the trace exporter.
	Name() string
}

TraceExporter composes TraceConsumer with some additional exporter-specific functions.