otelcol

package
v0.34.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultQueueArguments = QueueArguments{
	Enabled:      true,
	NumConsumers: 10,

	QueueSize: 5000,
}

DefaultQueueArguments holds default settings for QueueArguments.

View Source 
var DefaultRetryArguments = RetryArguments{
	Enabled:         true,
	InitialInterval: 5 * time.Second,
	MaxInterval:     30 * time.Second,
	MaxElapsedTime:  5 * time.Minute,
}

DefaultRetryArguments holds default settings for RetryArguments.

View Source 
var DefaultTimeout = 5 * time.Second

DefaultTimeout holds the default timeout used for components which can time out from requests.

Functions

This section is empty.

Types

type CORSArguments 

type CORSArguments struct {
	AllowedOrigins []string `river:"allowed_origins,attr,optional"`
	AllowedHeaders []string `river:"allowed_headers,attr,optional"`

	MaxAge int `river:"max_age,attr,optional"`
}

CORSArguments holds shared CORS settings for components which launch HTTP servers.

func (*CORSArguments) Convert 

func (args *CORSArguments) Convert() *otelconfighttp.CORSSettings

Convert converts args into the upstream type.

type CompressionType 

type CompressionType string

CompressionType represents a mechanism used to compress data. 

const (
	CompressionTypeGzip    CompressionType = "gzip"
	CompressionTypeZlib    CompressionType = "zlib"
	CompressionTypeDeflate CompressionType = "deflate"
	CompressionTypeSnappy  CompressionType = "snappy"
	CompressionTypeZstd    CompressionType = "zstd"
	CompressionTypeNone    CompressionType = "none"
	CompressionTypeEmpty   CompressionType = ""
)

Supported values for compression

func (CompressionType) Convert 

func (ct CompressionType) Convert() configcompression.CompressionType

Convert converts ct into the upstream type.

func (*CompressionType) UnmarshalText 

func (ct *CompressionType) UnmarshalText(in []byte) error

UnmarshalText converts a string into a CompressionType. Returns an error if the string is invalid.

type Consumer 

type Consumer interface {
	otelconsumer.Traces
	otelconsumer.Metrics
	otelconsumer.Logs
}

Consumer is a combined OpenTelemetry Collector consumer which can consume any telemetry signal.

type ConsumerArguments 

type ConsumerArguments struct {
	Metrics []Consumer `river:"metrics,attr,optional"`
	Logs    []Consumer `river:"logs,attr,optional"`
	Traces  []Consumer `river:"traces,attr,optional"`
}

ConsumerArguments is a common Arguments type for Flow components which can send data to otelcol consumers.

It is expected to use ConsumerArguments as a block within the top-level arguments block for a component.

type ConsumerExports 

type ConsumerExports struct {
	Input Consumer `river:"input,attr"`
}

ConsumerExports is a common Exports type for Flow components which are otelcol processors or otelcol exporters.

type GRPCClientArguments 

type GRPCClientArguments struct {
	Endpoint string `river:"endpoint,attr"`

	Compression CompressionType `river:"compression,attr,optional"`

	TLS       TLSClientArguments        `river:"tls,block,optional"`
	Keepalive *KeepaliveClientArguments `river:"keepalive,block,optional"`

	ReadBufferSize  units.Base2Bytes  `river:"read_buffer_size,attr,optional"`
	WriteBufferSize units.Base2Bytes  `river:"write_buffer_size,attr,optional"`
	WaitForReady    bool              `river:"wait_for_ready,attr,optional"`
	Headers         map[string]string `river:"headers,attr,optional"`
	BalancerName    string            `river:"balancer_name,attr,optional"`

	// Auth is a binding to an otelcol.auth.* component extension which handles
	// authentication.
	Auth *auth.Handler `river:"auth,attr,optional"`
}

GRPCClientArguments holds shared gRPC settings for components which launch gRPC clients.

func (*GRPCClientArguments) Convert 

func (args *GRPCClientArguments) Convert() *otelconfiggrpc.GRPCClientSettings

Convert converts args into the upstream type.

func (*GRPCClientArguments) Extensions 

func (args *GRPCClientArguments) Extensions() map[otelconfig.ComponentID]otelcomponent.Extension

Extensions exposes extensions used by args.

type GRPCServerArguments 

type GRPCServerArguments struct {
	Endpoint  string `river:"endpoint,attr,optional"`
	Transport string `river:"transport,attr,optional"`

	TLS *TLSServerArguments `river:"tls,block,optional"`

	MaxRecvMsgSize       units.Base2Bytes `river:"max_recv_msg_size,attr,optional"`
	MaxConcurrentStreams uint32           `river:"max_concurrent_streams,attr,optional"`
	ReadBufferSize       units.Base2Bytes `river:"read_buffer_size,attr,optional"`
	WriteBufferSize      units.Base2Bytes `river:"write_buffer_size,attr,optional"`

	Keepalive *KeepaliveServerArguments `river:"keepalive,block,optional"`

	IncludeMetadata bool `river:"include_metadata,attr,optional"`
}

GRPCServerArguments holds shared gRPC settings for components which launch gRPC servers.

func (*GRPCServerArguments) Convert 

func (args *GRPCServerArguments) Convert() *otelconfiggrpc.GRPCServerSettings

Convert converts args into the upstream type.

type HTTPClientArguments 

type HTTPClientArguments struct {
	Endpoint string `river:"endpoint,attr"`

	Compression CompressionType `river:"compression,attr,optional"`

	TLS TLSClientArguments `river:"tls,block,optional"`

	ReadBufferSize  units.Base2Bytes  `river:"read_buffer_size,attr,optional"`
	WriteBufferSize units.Base2Bytes  `river:"write_buffer_size,attr,optional"`
	Timeout         time.Duration     `river:"timeout,attr,optional"`
	Headers         map[string]string `river:"headers,attr,optional"`
	// CustomRoundTripper  func(next http.RoundTripper) (http.RoundTripper, error) TODO (@tpaschalis)
	MaxIdleConns        *int           `river:"max_idle_conns,attr,optional"`
	MaxIdleConnsPerHost *int           `river:"max_idle_conns_per_host,attr,optional"`
	MaxConnsPerHost     *int           `river:"max_conns_per_host,attr,optional"`
	IdleConnTimeout     *time.Duration `river:"idle_conn_timeout,attr,optional"`

	// Auth is a binding to an otelcol.auth.* component extension which handles
	// authentication.
	Auth *auth.Handler `river:"auth,attr,optional"`
}

HTTPClientArguments holds shared HTTP settings for components which launch HTTP clients.

func (*HTTPClientArguments) Convert 

func (args *HTTPClientArguments) Convert() *otelconfighttp.HTTPClientSettings

Convert converts args into the upstream type.

func (*HTTPClientArguments) Extensions 

func (args *HTTPClientArguments) Extensions() map[otelconfig.ComponentID]otelcomponent.Extension

Extensions exposes extensions used by args.

type HTTPServerArguments 

type HTTPServerArguments struct {
	Endpoint string `river:"endpoint,attr,optional"`

	TLS *TLSServerArguments `river:"tls,block,optional"`

	CORS *CORSArguments `river:"cors,block,optional"`

	MaxRequestBodySize units.Base2Bytes `river:"max_request_body_size,attr,optional"`
	IncludeMetadata    bool             `river:"include_metadata,attr,optional"`
}

HTTPServerArguments holds shared settings for components which launch HTTP servers.

func (*HTTPServerArguments) Convert 

func (args *HTTPServerArguments) Convert() *otelconfighttp.HTTPServerSettings

Convert converts args into the upstream type.

type KeepaliveClientArguments 

type KeepaliveClientArguments struct {
	PingWait            time.Duration `river:"ping_wait,attr,optional"`
	PingResponseTimeout time.Duration `river:"ping_response_timeout,attr,optional"`
	PingWithoutStream   bool          `river:"ping_without_stream,attr,optional"`
}

KeepaliveClientArguments holds shared keepalive settings for components which launch clients.

func (*KeepaliveClientArguments) Convert 

func (args *KeepaliveClientArguments) Convert() *otelconfiggrpc.KeepaliveClientConfig

Convert converts args into the upstream type.

type KeepaliveEnforcementPolicy 

type KeepaliveEnforcementPolicy struct {
	MinTime             time.Duration `river:"min_time,attr,optional"`
	PermitWithoutStream bool          `river:"permit_without_stream,attr,optional"`
}

KeepaliveEnforcementPolicy holds shared keepalive settings for components which launch servers.

func (*KeepaliveEnforcementPolicy) Convert 

func (args *KeepaliveEnforcementPolicy) Convert() *otelconfiggrpc.KeepaliveEnforcementPolicy

Convert converts args into the upstream type.

type KeepaliveServerArguments 

type KeepaliveServerArguments struct {
	ServerParameters  *KeepaliveServerParamaters  `river:"server_parameters,block,optional"`
	EnforcementPolicy *KeepaliveEnforcementPolicy `river:"enforcement_policy,block,optional"`
}

KeepaliveServerArguments holds shared keepalive settings for components which launch servers.

func (*KeepaliveServerArguments) Convert 

func (args *KeepaliveServerArguments) Convert() *otelconfiggrpc.KeepaliveServerConfig

Convert converts args into the upstream type.

type KeepaliveServerParamaters 

type KeepaliveServerParamaters struct {
	MaxConnectionIdle     time.Duration `river:"max_connection_idle,attr,optional"`
	MaxConnectionAge      time.Duration `river:"max_connection_age,attr,optional"`
	MaxConnectionAgeGrace time.Duration `river:"max_connection_age_grace,attr,optional"`
	Time                  time.Duration `river:"time,attr,optional"`
	Timeout               time.Duration `river:"timeout,attr,optional"`
}

KeepaliveServerParamaters holds shared keepalive settings for components which launch servers.

func (*KeepaliveServerParamaters) Convert 

func (args *KeepaliveServerParamaters) Convert() *otelconfiggrpc.KeepaliveServerParameters

Convert converts args into the upstream type.

type QueueArguments 

type QueueArguments struct {
	Enabled      bool `river:"enabled,attr,optional"`
	NumConsumers int  `river:"num_consumers,attr,optional"`
	QueueSize    int  `river:"queue_size,attr,optional"`
}

QueueArguments holds shared settings for components which can queue requests.

func (*QueueArguments) Convert 

func (args *QueueArguments) Convert() *otelexporterhelper.QueueSettings

Convert converts args into the upstream type.

func (*QueueArguments) UnmarshalRiver 

func (args *QueueArguments) UnmarshalRiver(f func(interface{}) error) error

UnmarshalRiver implements river.Unmarshaler.

func (*QueueArguments) Validate 

func (args *QueueArguments) Validate() error

Validate returns an error if args is invalid.

type RetryArguments 

type RetryArguments struct {
	Enabled         bool          `river:"enabled,attr,optional"`
	InitialInterval time.Duration `river:"initial_interval,attr,optional"`
	MaxInterval     time.Duration `river:"max_interval,attr,optional"`
	MaxElapsedTime  time.Duration `river:"max_elapsed_time,attr,optional"`
}

RetryArguments holds shared settings for components which can retry requests.

func (*RetryArguments) Convert 

func (args *RetryArguments) Convert() *otelexporterhelper.RetrySettings

Convert converts args into the upstream type.

func (*RetryArguments) UnmarshalRiver 

func (args *RetryArguments) UnmarshalRiver(f func(interface{}) error) error

UnmarshalRiver implements river.Unmarshaler.

type TLSClientArguments 

type TLSClientArguments struct {
	TLSSetting TLSSetting `river:",squash"`

	Insecure           bool   `river:"insecure,attr,optional"`
	InsecureSkipVerify bool   `river:"insecure_skip_verify,attr,optional"`
	ServerName         string `river:"server_name,attr,optional"`
}

TLSClientArguments holds shared TLS settings for components which launch TLS clients.

func (*TLSClientArguments) Convert 

func (args *TLSClientArguments) Convert() *otelconfigtls.TLSClientSetting

Convert converts args into the upstream type.

type TLSServerArguments 

type TLSServerArguments struct {
	TLSSetting TLSSetting `river:",squash"`

	ClientCAFile string `river:"client_ca_file,attr,optional"`
}

TLSServerArguments holds shared TLS settings for components which launch servers with TLS.

func (*TLSServerArguments) Convert 

func (args *TLSServerArguments) Convert() *otelconfigtls.TLSServerSetting

Convert converts args into the upstream type.

type TLSSetting added in v0.33.0 

type TLSSetting struct {
	CA             string            `river:"ca_pem,attr,optional"`
	CAFile         string            `river:"ca_file,attr,optional"`
	Cert           string            `river:"cert_pem,attr,optional"`
	CertFile       string            `river:"cert_file,attr,optional"`
	Key            rivertypes.Secret `river:"key_pem,attr,optional"`
	KeyFile        string            `river:"key_file,attr,optional"`
	MinVersion     string            `river:"min_version,attr,optional"`
	MaxVersion     string            `river:"max_version,attr,optional"`
	ReloadInterval time.Duration     `river:"reload_interval,attr,optional"`
}

func (*TLSSetting) Convert added in v0.33.0 

func (args *TLSSetting) Convert() *otelconfigtls.TLSSetting

func (*TLSSetting) UnmarshalRiver added in v0.33.0 

func (t *TLSSetting) UnmarshalRiver(f func(interface{}) error) error

UnmarshalRiver implements river.Unmarshaler and reports whether the unmarshaled TLSConfig is valid.

func (*TLSSetting) Validate added in v0.33.0 

func (t *TLSSetting) Validate() error

Validate reports whether t is valid.

Source Files

View all Source files

Directories

Path Synopsis
Package auth provides utilities to create a Flow component from OpenTelemetry Collector authentication extensions.
 Package auth provides utilities to create a Flow component from OpenTelemetry Collector authentication extensions.
basic
Package basic provides an otelcol.auth.basic component.
 Package basic provides an otelcol.auth.basic component.
bearer
Package bearer provides an otelcol.auth.bearer component.
 Package bearer provides an otelcol.auth.bearer component.
headers
Package headers provides an otelcol.auth.headers component.
 Package headers provides an otelcol.auth.headers component.
oauth2
sigv4
Package exporter exposes utilities to create a Flow component from OpenTelemetry Collector exporters.
 Package exporter exposes utilities to create a Flow component from OpenTelemetry Collector exporters.
jaeger
Package jaeger provides an otelcol.exporter.jaeger component.
 Package jaeger provides an otelcol.exporter.jaeger component.
logging
Package logging provides an otelcol.exporter.logging component.
 Package logging provides an otelcol.exporter.logging component.
loki
Package loki provides an otelcol.exporter.loki component.
 Package loki provides an otelcol.exporter.loki component.
loki/internal/convert
Package convert implements conversion utilities to convert between OpenTelemetry Collector and Loki data.
 Package convert implements conversion utilities to convert between OpenTelemetry Collector and Loki data.
otlp
Package otlp provides an otelcol.exporter.otlp component.
 Package otlp provides an otelcol.exporter.otlp component.
otlphttp
Package otlphttp provides an otelcol.exporter.otlphttp component.
 Package otlphttp provides an otelcol.exporter.otlphttp component.
prometheus
Package prometheus provides an otelcol.exporter.prometheus component.
 Package prometheus provides an otelcol.exporter.prometheus component.
prometheus/internal/convert
Package convert implements conversion utilities to convert between OpenTelemetry Collector data and Prometheus data.
 Package convert implements conversion utilities to convert between OpenTelemetry Collector data and Prometheus data.
Package extension provides utilities to create a Flow component from OpenTelemetry Collector extensions.
 Package extension provides utilities to create a Flow component from OpenTelemetry Collector extensions.
jaeger_remote_sampling
jaeger_remote_sampling/internal/jaegerremotesampling
jaeger_remote_sampling/internal/jaegerremotesampling/internal
jaeger_remote_sampling/internal/strategy_store
internal
fakeconsumer
fanoutconsumer
featuregate
Package featuregate automatically enables upstream feature gates that otelcol components require.
 Package featuregate automatically enables upstream feature gates that otelcol components require.
lazycollector
lazyconsumer
Package lazyconsumer implements a lazy OpenTelemetry Collector consumer which can lazily forward request to another consumer implementation.
 Package lazyconsumer implements a lazy OpenTelemetry Collector consumer which can lazily forward request to another consumer implementation.
scheduler
Package scheduler exposes utilities for scheduling and running OpenTelemetry Collector components.
 Package scheduler exposes utilities for scheduling and running OpenTelemetry Collector components.
Package processor exposes utilities to create a Flow component from OpenTelemetry Collector processors.
 Package processor exposes utilities to create a Flow component from OpenTelemetry Collector processors.
batch
Package batch provides an otelcol.processor.batch component.
 Package batch provides an otelcol.processor.batch component.
memorylimiter
Package memorylimiter provides an otelcol.processor.memory_limiter component.
 Package memorylimiter provides an otelcol.processor.memory_limiter component.
tail_sampling
Package tail_sampling provides an otelcol.processor.tail_sampling component.
 Package tail_sampling provides an otelcol.processor.tail_sampling component.
Package receiver utilities to create a Flow component from OpenTelemetry Collector receivers.
 Package receiver utilities to create a Flow component from OpenTelemetry Collector receivers.
jaeger
Package jaeger provides an otelcol.receiver.jaeger component.
 Package jaeger provides an otelcol.receiver.jaeger component.
kafka
Package kafka provides an otelcol.receiver.kafka component.
 Package kafka provides an otelcol.receiver.kafka component.
loki
Package loki provides an otelcol.receiver.loki component.
 Package loki provides an otelcol.receiver.loki component.
opencensus
Package opencensus provides an otelcol.receiver.opencensus component.
 Package opencensus provides an otelcol.receiver.opencensus component.
otlp
Package otlp provides an otelcol.receiver.otlp component.
 Package otlp provides an otelcol.receiver.otlp component.
prometheus
Package prometheus provides an otelcol.receiver.prometheus component.
 Package prometheus provides an otelcol.receiver.prometheus component.
prometheus/internal
Package internal is a near copy of https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.61.0/receiver/prometheusreceiver/internal A copy was made because the upstream package is internal.
 Package internal is a near copy of https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.61.0/receiver/prometheusreceiver/internal A copy was made because the upstream package is internal.
zipkin
Package zipkin provides an otelcol.receiver.zipkin component.
 Package zipkin provides an otelcol.receiver.zipkin component.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.