otlpexporter

README

OTLP gRPC Exporter

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

⚠ OTLP metrics and logs formats are currently marked as "Alpha" and may change in incompatible way any time.

Supported pipeline types: traces, metrics

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.

By default, TLS is enabled:

• insecure (default = false): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required:

• cert_file (no default): path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
• key_file (no default): path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.

Example:

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

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() component.ExporterFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for OTLP exporter.

Types

type Config

type Config struct {
	config.ExporterSettings        `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded 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.
}

Config defines configuration for OpenCensus exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid