otlpexporter

README

OTLP gRPC Exporter

Status
Stability	alpha: profiles
	stable: traces, metrics, logs
Distributions	core, contrib, k8s, otlp
Issues

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.
• retry_on_failure: see Retry on Failure for the full set of available options.
• sending_queue: see Sending Queue for the full set of available options.
• timeout (default = 5s): Time to wait per individual attempt to send data to a backend.

Example:

exporters:
  otlp_grpc:
    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_grpc:
    ...
    compression: none

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

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

Documentation

Overview

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

Index

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

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for OTLP exporter.

Types

type Config

type Config struct {
	TimeoutConfig exporterhelper.TimeoutConfig                             `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
	QueueConfig   configoptional.Optional[exporterhelper.QueueBatchConfig] `mapstructure:"sending_queue"`
	RetryConfig   configretry.BackOffConfig                                `mapstructure:"retry_on_failure"`
	ClientConfig  configgrpc.ClientConfig                                  `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
	// contains filtered or unexported fields
}

Config defines configuration for OTLP exporter.

func (*Config) Validate

func (c *Config) Validate() error