otlp

Documentation

Overview

Package otlp provides an otelcol.receiver.otlp component.

Index

• Variables
• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcol.DebugMetricsArguments
  • func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) Validate() error
• type GRPCServerArguments
  • func (args *GRPCServerArguments) SetToDefault()
• type HTTPConfigArguments
  • func (args *HTTPConfigArguments) Convert() *otlpreceiver.HTTPConfig
  • func (args *HTTPConfigArguments) SetToDefault()

Variables

var (
	DefaultGRPCServerArguments = GRPCServerArguments{
		Endpoint:  "0.0.0.0:4317",
		Transport: "tcp",

		ReadBufferSize: 512 * units.Kibibyte,
	}

	DefaultHTTPConfigArguments = HTTPConfigArguments{
		HTTPServerArguments: &otelcol.HTTPServerArguments{
			Endpoint: "0.0.0.0:4318",
		},
		MetricsURLPath: "/v1/metrics",
		LogsURLPath:    "/v1/logs",
		TracesURLPath:  "/v1/traces",
	}
)

Default server settings.

Types

type Arguments

type Arguments struct {
	GRPC *GRPCServerArguments `river:"grpc,block,optional"`
	HTTP *HTTPConfigArguments `river:"http,block,optional"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcol.DebugMetricsArguments `river:"debug_metrics,block,optional"`

	// Output configures where to send received data. Required.
	Output *otelcol.ConsumerArguments `river:"output,block"`
}

Arguments configures the otelcol.receiver.otlp component.

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements receiver.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcol.DebugMetricsArguments

DebugMetricsConfig implements receiver.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component

Exporters implements receiver.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension

Extensions implements receiver.Arguments.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements receiver.Arguments.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements river.Validator.

type GRPCServerArguments

type GRPCServerArguments otelcol.GRPCServerArguments

GRPCServerArguments is used to configure otelcol.receiver.otlp with component-specific defaults.

func (*GRPCServerArguments) SetToDefault

func (args *GRPCServerArguments) SetToDefault()

SetToDefault implements river.Defaulter.

type HTTPConfigArguments

type HTTPConfigArguments struct {
	HTTPServerArguments *otelcol.HTTPServerArguments `river:",squash"`

	// The URL path to receive traces on. If omitted "/v1/traces" will be used.
	TracesURLPath string `river:"traces_url_path,attr,optional"`

	// The URL path to receive metrics on. If omitted "/v1/metrics" will be used.
	MetricsURLPath string `river:"metrics_url_path,attr,optional"`

	// The URL path to receive logs on. If omitted "/v1/logs" will be used.
	LogsURLPath string `river:"logs_url_path,attr,optional"`
}

func (*HTTPConfigArguments) Convert

func (args *HTTPConfigArguments) Convert() *otlpreceiver.HTTPConfig

Convert converts args into the upstream type.

func (*HTTPConfigArguments) SetToDefault

func (args *HTTPConfigArguments) SetToDefault()

SetToDefault implements river.Defaulter.