otel

Documentation

Overview

+kubebuilder:validation:Optional

Index

• Constants
• func AgentOTELComponents(cache *entitycache.EntityCache, promRegistry *prometheus.Registry, ...) (component.Factories, error)
• func ControllerOTELComponents() (component.Factories, error)
• type BatchConfig
  • func (in *BatchConfig) DeepCopy() *BatchConfig
  • func (in *BatchConfig) DeepCopyInto(out *BatchConfig)
• type FxIn
• type OTELConfigConstructor
  • func (c OTELConfigConstructor) Annotate() fx.Option
• type OtelConfig
  • func (in *OtelConfig) DeepCopy() *OtelConfig
  • func (in *OtelConfig) DeepCopyInto(out *OtelConfig)
• type Type

Constants

const (
	// ReceiverOTLP collects logs from libraries and SDKs.
	ReceiverOTLP = "otlp"
	// ReceiverPrometheus collects metrics from environment and services.
	ReceiverPrometheus = "prometheus"

	// ProcessorEnrichment enriches metrics with discovery data.
	ProcessorEnrichment = "enrichment"
	// ProcessorMetrics generates metrics based on logs and exposes them
	// on application prometheus metrics endpoint.
	ProcessorMetrics = "metrics"
	// ProcessorBatchPrerollup batches incoming data before rolling up. This is
	// required, as rollup processor can only roll up data inside a single batch.
	ProcessorBatchPrerollup = "batch/prerollup"
	// ProcessorBatchPostrollup batches data after rolling up, as roll up process
	// shrinks number of data points significantly.
	ProcessorBatchPostrollup = "batch/postrollup"
	// ProcessorRollup rolls up data to decrease cardinality.
	ProcessorRollup = "rollup"
	// ProcessorAgentGroup adds `agent_group` attribute.
	ProcessorAgentGroup = "attributes/agent_group"

	// ExporterLogging exports telemetry using Aperture logger.
	ExporterLogging = "aperturelogging"
	// ExporterPrometheusRemoteWrite exports metrics to local prometheus instance.
	ExporterPrometheusRemoteWrite = "prometheusremotewrite"
)

Functions

func AgentOTELComponents

func AgentOTELComponents(
	cache *entitycache.EntityCache,
	promRegistry *prometheus.Registry,
	engine iface.Engine,
	metricsAPI iface.ResponseMetricsAPI,
	serverGRPC *grpc.Server,
) (component.Factories, error)

AgentOTELComponents constructs OTEL Collector Factories for Agent.

func ControllerOTELComponents

func ControllerOTELComponents() (component.Factories, error)

ControllerOTELComponents constructs OTEL Collector Factories for Controller.

Types

type BatchConfig

type BatchConfig struct {
	// Timeout sets the time after which a batch will be sent regardless of size.
	Timeout config.Duration `json:"timeout" validate:"gt=0" default:"1s"`

	// SendBatchSize is the size of a batch which after hit, will trigger it to be sent.
	SendBatchSize uint32 `json:"send_batch_size" validate:"gt=0" default:"10000"`
}

BatchConfig defines configuration for OTEL batch processor. swagger:model +kubebuilder:object:generate=true

func (*BatchConfig) DeepCopy

func (in *BatchConfig) DeepCopy() *BatchConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BatchConfig.

func (*BatchConfig) DeepCopyInto

func (in *BatchConfig) DeepCopyInto(out *BatchConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FxIn

type FxIn struct {
	fx.In
	Unmarshaller    config.Unmarshaller
	Listener        *listener.Listener
	PromClient      promapi.Client
	TLSConfig       *tls.Config
	ServerTLSConfig tlsconfig.ServerTLSConfig
}

FxIn consumes parameters via Fx.

type OTELConfigConstructor

type OTELConfigConstructor struct {
	Type Type
}

OTELConfigConstructor is the constructor for the OTEL collector configuration.

func (OTELConfigConstructor) Annotate

func (c OTELConfigConstructor) Annotate() fx.Option

Annotate provides fx options.

type OtelConfig

type OtelConfig struct {
	// BatchPrerollup configures batch prerollup processor.
	BatchPrerollup BatchConfig `json:"batch_prerollup"`
	// BatchPostrollup configures batch postrollup processor.
	BatchPostrollup BatchConfig `json:"batch_postrollup"`
}

OtelConfig is the configuration for the OTEL collector. swagger:model +kubebuilder:object:generate=true

func (*OtelConfig) DeepCopy

func (in *OtelConfig) DeepCopy() *OtelConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OtelConfig.

func (*OtelConfig) DeepCopyInto

func (in *OtelConfig) DeepCopyInto(out *OtelConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Type

type Type int

Type decides which configuration to use.

const (
	// AgentType instantiates agent pipeline.
	AgentType Type = iota
	// ControllerType instantiates controller pipeline.
	ControllerType
)