otlphttpexporter

README

OTLP HTTP Exporter

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

The otlp_http exporter sends logs, metrics, profiles and traces via HTTP using OTLP format.

The otlphttp deprecated alias exists for the component name. It will be removed in a future version. If you use the deprecated alias otlphttp in your configuration, change it to otlp_http.

The following settings are required:

• endpoint (no default): The target base URL to send data to (e.g.: https://example.com:4318). To send each signal a corresponding path will be added to this base URL, i.e. for traces "/v1/traces" will appended, for metrics "/v1/metrics" will be appended, for logs "/v1/logs" will be appended.

The following settings can be optionally configured:

• traces_endpoint (no default): The target URL to send trace data to (e.g.: https://example.com:4318/v1/traces). If this setting is present the endpoint setting is ignored for traces.
• metrics_endpoint (no default): The target URL to send metric data to (e.g.: https://example.com:4318/v1/metrics). If this setting is present the endpoint setting is ignored for metrics.
• logs_endpoint (no default): The target URL to send log data to (e.g.: https://example.com:4318/v1/logs).
• profiles_endpoint (no default): The target URL to send profile data to (e.g.: https://example.com:4318/v1development/profiles). If this setting is present the endpoint setting is ignored for logs.
• tls: see TLS Configuration Settings for the full set of available options.
• timeout (default = 30s): HTTP request time limit. For details see https://golang.org/pkg/net/http/#Client
• read_buffer_size (default = 0): ReadBufferSize for HTTP client.
• write_buffer_size (default = 512 * 1024): WriteBufferSize for HTTP client.
• encoding (default = proto): The encoding to use for the messages (valid options: proto, json)
• 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.

Example:

exporters:
  otlp_http:
    endpoint: https://example.com:4318

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

exporters:
  otlp_http:
    ...
    compression: none

By default proto encoding is used, to change the content encoding of the message configure it as follows:

exporters:
  otlp_http:
    ...
    encoding: json

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

Documentation

Overview

Package otlphttpexporter exports data by using the OTLP format to an HTTP endpoint.

Index

• func NewFactory() exporter.Factory
• type Config
  • func (cfg *Config) Validate() error
• type EncodingType
  • func (e *EncodingType) UnmarshalText(text []byte) error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for OTLP exporter.

Types

type Config

type Config struct {
	ClientConfig confighttp.ClientConfig                                  `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"`

	// The URL to send traces to. If omitted the Endpoint + "/v1/traces" will be used.
	TracesEndpoint string `mapstructure:"traces_endpoint"`

	// The URL to send metrics to. If omitted the Endpoint + "/v1/metrics" will be used.
	MetricsEndpoint string `mapstructure:"metrics_endpoint"`

	// The URL to send logs to. If omitted the Endpoint + "/v1/logs" will be used.
	LogsEndpoint string `mapstructure:"logs_endpoint"`

	// The URL to send profiles to. If omitted the Endpoint + "/v1development/profiles" will be used.
	ProfilesEndpoint string `mapstructure:"profiles_endpoint"`

	// The encoding to export telemetry (default: "proto")
	Encoding EncodingType `mapstructure:"encoding"`
}

Config defines configuration for OTLP/HTTP exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid

type EncodingType

type EncodingType string

EncodingType defines the type for content encoding

const (
	EncodingProto EncodingType = "proto"
	EncodingJSON  EncodingType = "json"
)

func (*EncodingType) UnmarshalText

func (e *EncodingType) UnmarshalText(text []byte) error

UnmarshalText unmarshalls text to an EncodingType.