otlpexporter

README

OTLP gRPC Exporter

Status
Stability	traces stable
	metrics stable
	logs beta
Supported pipeline types	traces, metrics, logs
Distributions	core, contrib

Export data via gRPC using OTLP format. By default, this exporter requires TLS and offers queued retry capabilities.

Getting Started

The following settings are required:

• endpoint (no default): host:port to which the exporter is going to send OTLP trace data, using the gRPC protocol. The valid syntax is described here. If a scheme of https is used then client transport security is enabled and overrides the insecure setting.
• tls: see TLS Configuration Settings for the full set of available options.

Example:

exporters:
  otlp:
    endpoint: otelcol2:4317
    tls:
      cert_file: file.cert
      key_file: file.key
  otlp/2:
    endpoint: otelcol2:4317
    tls:
      insecure: true

By default, gzip compression is enabled. See compression comparison for details benchmark information. To disable, configure as follows:

exporters:
  otlp:
    ...
    compression: none

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

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

Documentation

Overview

Package otlpexporter exports data by using the OTLP format to a gPRC endpoint.

Index

• func NewFactory() exporter.Factory
• type ArrowSettings
  • func (cfg *ArrowSettings) Validate() error
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for OTLP exporter.

Types

type ArrowSettings

type ArrowSettings struct {
	Enabled          bool `mapstructure:"enabled"`
	NumStreams       int  `mapstructure:"num_streams"`
	DisableDowngrade bool `mapstructure:"disable_downgrade"`
}

ArrowSettings includes whether Arrow is enabled and the number of concurrent Arrow streams.

func (*ArrowSettings) Validate

func (cfg *ArrowSettings) Validate() error

Validate returns an error when the number of streams is less than 1.

type Config

type Config struct {
	exporterhelper.TimeoutSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
	exporterhelper.QueueSettings   `mapstructure:"sending_queue"`
	exporterhelper.RetrySettings   `mapstructure:"retry_on_failure"`

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

	Arrow ArrowSettings `mapstructure:"arrow"`
}

Config defines configuration for OpenCensus exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid