odiglet

README

Odiglet

Development

One of Odiglet's jobs is to manage the different eBPF instrumentations. Loading an eBPF instrumentation requires having compiled eBPF programs (.o files). This compilation is taking place in Odiglet's Dockerfile and it requires the auto instrumentation code. This makes debugging locally on a non-linux system different compared to the other Odigos components. Assuming a setup with an active kind cluster with Odigos installed:

1. Run make debug-odiglet or TAG=<some_tag> make debug-odiglet which will build Odiglet in a debug image which includes a Go debugger. In addition, it will port-forward the debugger port for remote debug.
2. Using vscode launch the Remote Odiglet configuration.
3. Debug the code.

Odiglet defaults to use the environment variable OTEL_LOG_LEVEL with value of info. When debugging or developing it is useful to increase the log level to debug for instrumentations. Note that this value only controls the log level for the instrumentations Odiglet invokes directly (eBPF) and does not apply for the k8s controllers or 3rd party agents.

Documentation

Index

• func OdigletInitPhase(clientset *kubernetes.Clientset)
• type Odiglet
  • func New(clientset *kubernetes.Clientset, ...) (*Odiglet, error)
  • func (o *Odiglet) Run(ctx context.Context)

Functions

func OdigletInitPhase

func OdigletInitPhase(clientset *kubernetes.Clientset)

Types

type Odiglet

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

func New

func New(clientset *kubernetes.Clientset, deviceInjectionCallbacks instrumentation.OtelSdksLsf, factories map[commonInstrumentation.OtelDistribution]commonInstrumentation.Factory) (*Odiglet, error)

New creates a new Odiglet instance.

func (*Odiglet) Run

func (o *Odiglet) Run(ctx context.Context)

Run starts the Odiglet components and blocks until the context is cancelled, or a critical error occurs.