beyla

Documentation

Index

• type Arguments
  • func (a *Arguments) Convert() (*beyla.Config, error)
  • func (args *Arguments) Validate() error
• type AttributeFamilies
• type AttributeFamily
• type Attributes
  • func (args Attributes) Convert() beyla.Attributes
• type Component
  • func New(opts component.Options, args Arguments) (*Component, error)
  • func (c *Component) CurrentHealth() component.Health
  • func (c *Component) Handler() http.Handler
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error
• type Discovery
  • func (args Discovery) Convert() (services.DiscoveryConfig, error)
• type EBPF
  • func (args EBPF) Convert() beylaCfg.EBPFTracer
• type Exports
• type Filters
  • func (args Filters) Convert() filter.AttributesConfig
• type InstanceIDConfig
• type KubernetesDecorator
• type KubernetesService
  • func (args KubernetesService) Convert() (map[string]*services.RegexpAttr, error)
• type Metrics
  • func (args Metrics) Convert() prom.PrometheusConfig
• type Network
  • func (args Network) Convert() beyla.NetworkConfig
• type Routes
  • func (args Routes) Convert() *transform.RoutesConfig
• type Selection
• type Selections
  • func (args Selections) Convert() attributes.Selection
• type Service
• type Services
  • func (args Services) Convert() (services.DefinitionCriteria, error)

Types

type Arguments

type Arguments struct {
	Port           string                     `alloy:"open_port,attr,optional"`
	ExecutableName string                     `alloy:"executable_name,attr,optional"`
	Debug          bool                       `alloy:"debug,attr,optional"`
	EnforceSysCaps bool                       `alloy:"enforce_sys_caps,attr,optional"`
	Routes         Routes                     `alloy:"routes,block,optional"`
	Attributes     Attributes                 `alloy:"attributes,block,optional"`
	Discovery      Discovery                  `alloy:"discovery,block,optional"`
	Metrics        Metrics                    `alloy:"metrics,block,optional"`
	EBPF           EBPF                       `alloy:"ebpf,block,optional"`
	Filters        Filters                    `alloy:"filters,block,optional"`
	Output         *otelcol.ConsumerArguments `alloy:"output,block,optional"`
}

Arguments configures the Beyla component.

func (*Arguments) Convert

func (a *Arguments) Convert() (*beyla.Config, error)

func (*Arguments) Validate

func (args *Arguments) Validate() error

type AttributeFamilies

type AttributeFamilies []AttributeFamily

type AttributeFamily

type AttributeFamily struct {
	Attr     string `alloy:",label"`
	Match    string `alloy:"match,attr,optional"`
	NotMatch string `alloy:"not_match,attr,optional"`
}

type Attributes

type Attributes struct {
	Kubernetes KubernetesDecorator `alloy:"kubernetes,block"`
	InstanceID InstanceIDConfig    `alloy:"instance_id,block,optional"`
	Select     Selections          `alloy:"select,block,optional"`
}

func (Attributes) Convert

func (args Attributes) Convert() beyla.Attributes

type Component

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

func New

func New(opts component.Options, args Arguments) (*Component, error)

func (*Component) CurrentHealth

func (c *Component) CurrentHealth() component.Health

func (*Component) Handler

func (c *Component) Handler() http.Handler

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run implements component.Component.

func (*Component) Update

func (c *Component) Update(args component.Arguments) error

Update implements component.Component.

type Discovery

type Discovery struct {
	Services                        Services `alloy:"services,block"`
	ExcludeServices                 Services `alloy:"exclude_services,block,optional"`
	DefaultExcludeServices          Services `alloy:"default_exclude_services,block,optional"`
	SkipGoSpecificTracers           bool     `alloy:"skip_go_specific_tracers,attr,optional"`
	ExcludeOTelInstrumentedServices bool     `alloy:"exclude_otel_instrumented_services,attr,optional"`
}

func (Discovery) Convert

func (args Discovery) Convert() (services.DiscoveryConfig, error)

type EBPF

type EBPF struct {
	WakeupLen                 int           `alloy:"wakeup_len,attr,optional"`
	TrackRequestHeaders       bool          `alloy:"track_request_headers,attr,optional"`
	HTTPRequestTimeout        time.Duration `alloy:"http_request_timeout,attr,optional"`
	ContextPropagationEnabled bool          `alloy:"enable_context_propagation,attr,optional"`
	HighRequestVolume         bool          `alloy:"high_request_volume,attr,optional"`
	HeuristicSQLDetect        bool          `alloy:"heuristic_sql_detect,attr,optional"`
}

func (EBPF) Convert

func (args EBPF) Convert() beylaCfg.EBPFTracer

type Exports

type Exports struct {
	Targets []discovery.Target `alloy:"targets,attr"`
}

type Filters

type Filters struct {
	Application AttributeFamilies `alloy:"application,block,optional"`
	Network     AttributeFamilies `alloy:"network,block,optional"`
}

func (Filters) Convert

func (args Filters) Convert() filter.AttributesConfig

type InstanceIDConfig

type InstanceIDConfig struct {
	HostnameDNSResolution bool   `alloy:"dns,attr,optional"`
	OverrideHostname      string `alloy:"override_hostname,attr,optional"`
}

type KubernetesDecorator

type KubernetesDecorator struct {
	Enable                string        `alloy:"enable,attr"`
	ClusterName           string        `alloy:"cluster_name,attr,optional"`
	InformersSyncTimeout  time.Duration `alloy:"informers_sync_timeout,attr,optional"`
	InformersResyncPeriod time.Duration `alloy:"informers_resync_period,attr,optional"`
	DisableInformers      []string      `alloy:"disable_informers,attr,optional"`
	MetaRestrictLocalNode bool          `alloy:"meta_restrict_local_node,attr,optional"`
}

type KubernetesService

type KubernetesService struct {
	Namespace       string            `alloy:"namespace,attr,optional"`
	PodName         string            `alloy:"pod_name,attr,optional"`
	DeploymentName  string            `alloy:"deployment_name,attr,optional"`
	ReplicaSetName  string            `alloy:"replicaset_name,attr,optional"`
	StatefulSetName string            `alloy:"statefulset_name,attr,optional"`
	DaemonSetName   string            `alloy:"daemonset_name,attr,optional"`
	OwnerName       string            `alloy:"owner_name,attr,optional"`
	PodLabels       map[string]string `alloy:"pod_labels,attr,optional"`
}

func (KubernetesService) Convert

func (args KubernetesService) Convert() (map[string]*services.RegexpAttr, error)

type Metrics

type Metrics struct {
	Features                        []string `alloy:"features,attr,optional"`
	Instrumentations                []string `alloy:"instrumentations,attr,optional"`
	AllowServiceGraphSelfReferences bool     `alloy:"allow_service_graph_self_references,attr,optional"`
	Network                         Network  `alloy:"network,block,optional"`
}

func (Metrics) Convert

func (args Metrics) Convert() prom.PrometheusConfig

type Network

type Network struct {
	Enable             bool          `alloy:"enable,attr"`
	Source             string        `alloy:"source,attr,optional"`
	AgentIP            string        `alloy:"agent_ip,attr,optional"`
	AgentIPIface       string        `alloy:"agent_ip_iface,attr,optional"`
	AgentIPType        string        `alloy:"agent_ip_type,attr,optional"`
	Interfaces         []string      `alloy:"interfaces,attr,optional"`
	ExcludeInterfaces  []string      `alloy:"exclude_interfaces,attr,optional"`
	Protocols          []string      `alloy:"protocols,attr,optional"`
	ExcludeProtocols   []string      `alloy:"exclude_protocols,attr,optional"`
	CacheMaxFlows      int           `alloy:"cache_max_flows,attr,optional"`
	CacheActiveTimeout time.Duration `alloy:"cache_active_timeout,attr,optional"`
	Direction          string        `alloy:"direction,attr,optional"`
	Sampling           int           `alloy:"sampling,attr,optional"`
	CIDRs              []string      `alloy:"cidrs,attr,optional"`
}

func (Network) Convert

func (args Network) Convert() beyla.NetworkConfig

type Routes

type Routes struct {
	Unmatch        string   `alloy:"unmatched,attr,optional"`
	Patterns       []string `alloy:"patterns,attr,optional"`
	IgnorePatterns []string `alloy:"ignored_patterns,attr,optional"`
	IgnoredEvents  string   `alloy:"ignore_mode,attr,optional"`
	WildcardChar   string   `alloy:"wildcard_char,attr,optional"`
}

func (Routes) Convert

func (args Routes) Convert() *transform.RoutesConfig

type Selection

type Selection struct {
	Section string   `alloy:",label"`
	Include []string `alloy:"include,attr"`
	Exclude []string `alloy:"exclude,attr"`
}

type Selections

type Selections []Selection

func (Selections) Convert

func (args Selections) Convert() attributes.Selection

type Service

type Service struct {
	Name       string            `alloy:"name,attr,optional"`
	Namespace  string            `alloy:"namespace,attr,optional"`
	OpenPorts  string            `alloy:"open_ports,attr,optional"`
	Path       string            `alloy:"exe_path,attr,optional"`
	Kubernetes KubernetesService `alloy:"kubernetes,block,optional"`
}

type Services

type Services []Service

func (Services) Convert

func (args Services) Convert() (services.DefinitionCriteria, error)