otlpreceiver

README

OTLP Receiver

Receives data via gRPC or HTTP using OTLP format.

Supported pipeline types: traces, metrics, logs

⚠ OTLP metrics format is currently marked as "Alpha" and may change in incompatible way any time.

Getting Started

All that is required to enable the OTLP receiver is to include it in the receiver definitions. A protocol can be disabled by simply not specifying it in the list of protocols.

receivers:
  otlp:
    protocols:
      grpc:
      http:

The following settings are configurable:

• endpoint (default = 0.0.0.0:4317 for grpc protocol, 0.0.0.0:55681 http protocol): host:port to which the receiver is going to receive data. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md.

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

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

Writing with HTTP/JSON

The OTLP receiver can receive trace export calls via HTTP/JSON in addition to gRPC. The HTTP/JSON address is the same as gRPC as the protocol is recognized and processed accordingly. Note the format needs to be protobuf JSON serialization.

To write traces with HTTP/JSON, POST to [address]/v1/traces for traces, to [address]/v1/metrics for metrics, to [address]/v1/logs for logs. The default port is 55681.

The HTTP/JSON endpoint can also optionally configure CORS, which is enabled by specifying a list of allowed CORS origins in the cors_allowed_origins and optionally headers in cors_allowed_headers:

receivers:
  otlp:
    protocols:
      http:
        endpoint: "localhost:55681"
        cors_allowed_origins:
        - http://test.com
        # Origins can have wildcards with *, use * by itself to match any origin.
        - https://*.example.com
        cors_allowed_headers:
        - TestHeader

Documentation

Overview

Package otlpreceiver receives data in OTLP format.

Index

• func NewFactory() component.ReceiverFactory
• type Config
  • func (cfg *Config) Unmarshal(componentParser *configparser.Parser) error
  • func (cfg *Config) Validate() error
• type Protocols

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a new OTLP receiver factory.

Types

type Config

type Config struct {
	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	// Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON).
	Protocols `mapstructure:"protocols"`
}

Config defines configuration for OTLP receiver.

func (*Config) Unmarshal

func (cfg *Config) Unmarshal(componentParser *configparser.Parser) error

Unmarshal a config.Parser into the config struct.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks the receiver configuration is valid

type Protocols

type Protocols struct {
	GRPC *configgrpc.GRPCServerSettings `mapstructure:"grpc"`
	HTTP *confighttp.HTTPServerSettings `mapstructure:"http"`
}

Protocols is the configuration for the supported protocols.