otlp

README

package otlp

This package is responsible for handling telemetry signals from external software in the OTLP format on any supported protocol (gRPC/protobuf, HTTP/JSON, HTTP/protobuf...).

Any telemetry signal sent via OTLP to the Agent must be sent to the endpoint defined by this package on the core Agent first, to support the single endpoint configuration of OTLP exporters defined by the OpenTelemetry specification. Telemetry signals may be forwarded to other agents internally after intake.

Documentation

Index

• func IsEnabled(cfg config.Config) bool
• type Pipeline
  • func BuildAndStart(ctx context.Context, cfg config.Config, s serializer.MetricSerializer) (*Pipeline, error)
  • func NewPipeline(cfg PipelineConfig, s serializer.MetricSerializer) (*Pipeline, error)
  • func (p *Pipeline) Run(ctx context.Context) error
  • func (p *Pipeline) Stop()
• type PipelineConfig
  • func FromAgentConfig(cfg config.Config) (PipelineConfig, error)

Functions

func IsEnabled

func IsEnabled(cfg config.Config) bool

IsEnabled checks if OTLP pipeline is enabled in a given config.

Types

type Pipeline

type Pipeline struct {
	// contains filtered or unexported fields
}

Pipeline is an OTLP pipeline.

func BuildAndStart

func BuildAndStart(ctx context.Context, cfg config.Config, s serializer.MetricSerializer) (*Pipeline, error)

BuildAndStart builds and starts an OTLP pipeline

func NewPipeline

func NewPipeline(cfg PipelineConfig, s serializer.MetricSerializer) (*Pipeline, error)

NewPipeline defines a new OTLP pipeline.

func (*Pipeline) Run

func (p *Pipeline) Run(ctx context.Context) error

Run the OTLP pipeline.

func (*Pipeline) Stop

func (p *Pipeline) Stop()

Stop the OTLP pipeline.

type PipelineConfig

type PipelineConfig struct {
	// BindHost is the bind host for the OTLP receiver.
	BindHost string
	// GRPCPort is the OTLP receiver gRPC port.
	GRPCPort uint
	// HTTPPort is the OTLP receiver HTTP port.
	HTTPPort uint
	// TracePort is the trace Agent OTLP port.
	TracePort uint
	// MetricsEnabled states whether OTLP metrics support is enabled.
	MetricsEnabled bool
	// TracesEnabled states whether OTLP traces support is enabled.
	TracesEnabled bool
}

PipelineConfig is the config struct for an OTLP pipeline.

func FromAgentConfig

func FromAgentConfig(cfg config.Config) (PipelineConfig, error)

FromAgentConfig builds a pipeline configuration from an Agent configuration.