beyla

Documentation

Overview

Package beyla provides public access to Beyla as a library. All the other subcomponents of Beyla are hidden.

Index

• type Config
  • func LoadConfig(reader io.Reader) (*Config, error)
• type Instrumenter
  • func New(config *Config) *Instrumenter
  • func (i *Instrumenter) FindAndInstrument(ctx context.Context) error
  • func (i *Instrumenter) ReadAndForward(ctx context.Context) error

Types

type Config

type Config pipe.Config

Config as provided by the user to configure and run Beyla

func LoadConfig

func LoadConfig(reader io.Reader) (*Config, error)

LoadConfig loads and validates configuration. Configuration from multiple source is overridden in the following order (from less to most priority): 1 - Default configuration 2 - Contents of the provided file reader (nillable) 3 - Environment variables

type Instrumenter

type Instrumenter struct {

	// TODO: temporary hack. REMOVE
	// This will force that the pipeline is not created until we have a service name.
	// In the following PR this will be removed, as we will include the service name
	// in the Span information, and create dynamically OTEL resources for each new
	// service (as we already do for system wide configuration): remove ASAP
	TempHackWaitForServiceName chan struct{}
	// contains filtered or unexported fields
}

Instrumenter finds and instrument a service/process, and forwards the traces as configured by the user

func New

func New(config *Config) *Instrumenter

New Instrumenter, given a Config

func (*Instrumenter) FindAndInstrument

func (i *Instrumenter) FindAndInstrument(ctx context.Context) error

FindAndInstrument searches in background for any new executable matching the selection criteria.

func (*Instrumenter) ReadAndForward

func (i *Instrumenter) ReadAndForward(ctx context.Context) error

ReadAndForward keeps listening for traces in the BPF map, then reads, processes and forwards them