otlp

package
v0.0.0-...-7983b3b Latest Latest
Warning

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

Go to latest
Published: Apr 8, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

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

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 {
	// OTLPReceiverConfig is the OTLP receiver configuration.
	OTLPReceiverConfig map[string]interface{}
	// 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

	// Metrics contains configuration options for the serializer metrics exporter
	Metrics map[string]interface{}
}

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.

Directories

Path Synopsis
internal
testutil
Package testutil includes OTLP-related test utilities.
Package testutil includes OTLP-related test utilities.
model module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL