otel: go.opentelemetry.io/otel/exporters/otlp Index | Files | Directories

package otlp

import "go.opentelemetry.io/otel/exporters/otlp"

Package otlp contains an exporter for the OpenTelemetry protocol buffers.

This package is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.


Package Files

doc.go options.go otlp.go protocoldriver.go


const (
    // DefaultCollectorPort is the port the Exporter will attempt connect to
    // if no collector port is provided.
    DefaultCollectorPort uint16 = 4317
    // DefaultCollectorHost is the host address the Exporter will attempt
    // connect to if no collector address is provided.
    DefaultCollectorHost string = "localhost"

type Exporter Uses

type Exporter struct {
    // contains filtered or unexported fields

Exporter is an OpenTelemetry exporter. It exports both traces and metrics from OpenTelemetry instrumented to code using OpenTelemetry protocol buffers to a configurable receiver.

func NewExporter Uses

func NewExporter(ctx context.Context, driver ProtocolDriver, opts ...ExporterOption) (*Exporter, error)

NewExporter constructs a new Exporter and starts it.

func NewUnstartedExporter Uses

func NewUnstartedExporter(driver ProtocolDriver, opts ...ExporterOption) *Exporter

NewUnstartedExporter constructs a new Exporter and does not start it.

func (*Exporter) Export Uses

func (e *Exporter) Export(parent context.Context, cps metricsdk.CheckpointSet) error

Export implements the "go.opentelemetry.io/otel/sdk/export/metric".Exporter interface. It transforms and batches metric Records into OTLP Metrics and transmits them to the configured collector.

func (*Exporter) ExportKindFor Uses

func (e *Exporter) ExportKindFor(desc *metric.Descriptor, kind aggregation.Kind) metricsdk.ExportKind

ExportKindFor reports back to the OpenTelemetry SDK sending this Exporter metric telemetry that it needs to be provided in a configured format.

func (*Exporter) ExportSpans Uses

func (e *Exporter) ExportSpans(ctx context.Context, ss []*tracesdk.SpanSnapshot) error

ExportSpans implements the "go.opentelemetry.io/otel/sdk/export/trace".SpanExporter interface. It transforms and batches trace SpanSnapshots into OTLP Trace and transmits them to the configured collector.

func (*Exporter) Shutdown Uses

func (e *Exporter) Shutdown(ctx context.Context) error

Shutdown closes all connections and releases resources currently being used by the exporter. If the exporter is not started this does nothing. A shut down exporter can't be started again. Shutting down an already shut down exporter does nothing.

func (*Exporter) Start Uses

func (e *Exporter) Start(ctx context.Context) error

Start establishes connections to the OpenTelemetry collector. Starting an already started exporter returns an error.

type ExporterOption Uses

type ExporterOption func(*config)

ExporterOption are setting options passed to an Exporter on creation.

func WithMetricExportKindSelector Uses

func WithMetricExportKindSelector(selector metricsdk.ExportKindSelector) ExporterOption

WithMetricExportKindSelector defines the ExportKindSelector used for selecting AggregationTemporality (i.e., Cumulative vs. Delta aggregation). If not specified otherwise, exporter will use a cumulative export kind selector.

type ProtocolDriver Uses

type ProtocolDriver interface {
    // Start should establish connection(s) to endpoint(s). It is
    // called just once by the exporter, so the implementation
    // does not need to worry about idempotence and locking.
    Start(ctx context.Context) error
    // Stop should close the connections. The function is called
    // only once by the exporter, so the implementation does not
    // need to worry about idempotence, but it may be called
    // concurrently with ExportMetrics or ExportTraces, so proper
    // locking is required. The function serves as a
    // synchronization point - after the function returns, the
    // process of closing connections is assumed to be finished.
    Stop(ctx context.Context) error
    // ExportMetrics should transform the passed metrics to the
    // wire format and send it to the collector. May be called
    // concurrently with ExportTraces, so the manager needs to
    // take this into account by doing proper locking.
    ExportMetrics(ctx context.Context, cps metricsdk.CheckpointSet, selector metricsdk.ExportKindSelector) error
    // ExportTraces should transform the passed traces to the wire
    // format and send it to the collector. May be called
    // concurrently with ExportMetrics, so the manager needs to
    // take this into account by doing proper locking.
    ExportTraces(ctx context.Context, ss []*tracesdk.SpanSnapshot) error

ProtocolDriver is an interface used by OTLP exporter. It's responsible for connecting to and disconnecting from the collector, and for transforming traces and metrics into wire format and transmitting them to the collector.

func NewSplitDriver Uses

func NewSplitDriver(cfg SplitConfig) ProtocolDriver

NewSplitDriver creates a protocol driver which contains two other protocol drivers and will forward traces to one of them and metrics to another.

type SplitConfig Uses

type SplitConfig struct {
    // ForMetrics driver will be used for sending metrics to the
    // collector.
    ForMetrics ProtocolDriver
    // ForTraces driver will be used for sending spans to the
    // collector.
    ForTraces ProtocolDriver

SplitConfig is used to configure a split driver.


internal/transformPackage transform provides translations for opentelemetry-go concepts and structures to otlp structures.
otlpgrpcPackage otlpgrpc provides an implementation of otlp.ProtocolDriver that connects to the collector and sends traces and metrics using gRPC.
otlphttpPackage otlphttp implements a protocol driver that sends traces and metrics to the collector using HTTP with binary protobuf payloads.

Package otlp imports 7 packages (graph) and is imported by 9 packages. Updated 2021-01-21. Refresh now. Tools for package owners.