beyla

Grafana Beyla

Open source zero-code automatic instrumentation with eBPF and OpenTelemetry.

Important Update for current and future Beyla contributors

Beyla has been donated to the CNCF OpenTelemetry Project, under the project name OpenTelemetry eBPF Instrumentation or OBI for short. We are in the process of vendoring most of the code that exists in the Beyla source repository from upstream. If you are working on a PR, unless it's related to documentation, please make the PR to the upstream repository. All Beyla current maintainers work full time on the upstream repository.

We expect that the process of migrating all development to the upstream repository to finish shortly. Some parts of the upstream codebase will likely be imported as a git submodule.

Introduction

Beyla is a vendor agnostic, eBPF-based, OpenTelemetry/Prometheus application auto-instrumentation tool, which lets you easily get started with Application Observability. eBPF is used to automatically inspect application executables and the OS networking layer, allowing us to capture essential application observability events for HTTP/S and gRPC services. From these captured eBPF events, we produce OpenTelemetry web transaction trace spans and Rate-Errors-Duration (RED) metrics. As with most eBPF tools, all data capture and instrumentation occurs without any modifications to your application code or configuration.

Community

To engage with the Beyla community and to chat with us on our community Slack channel, please invite yourself to the Grafana Slack, visit https://slack.grafana.com/ and join the #beyla channel.

We also run a monthly Beyla community call, on the second Wednesday of the month at 4pm UTC. You can find all of the details about our community call on the Grafana Community Calendar.

Getting Started

To try out Beyla, you need to run a network service for Beyla to instrument. Beyla supports a wide range of programming languages (Go, Java, .NET, NodeJS, Python, Ruby, Rust, etc.), so if you already have an example service you can use it. If you don't have an example, you can download and run example-http-service.go from the examples/ directory:

curl -OL https://raw.githubusercontent.com/grafana/beyla/main/examples/example-http-service/example-http-service.go
go run ./example-http-service.go

Next, generate some traffic. The following command will trigger a GET request to http://localhost:8080 every two seconds.

watch curl -s http://localhost:8080

Now that we have an example running, we are ready to download and run Beyla.

First, download and unpack the latest release from the GitHub releases page. The release should contain the ./beyla executable.

Beyla supports multiple ways to find the service to be instrumented (by network port, executable name, process ID), and multiple exposition formats (Prometheus, OpenTelemetry metrics, Distributed Traces for Go, Single Span traces for other languages).

For getting started, we'll tell Beyla to instrument the service running on port 8080 (our example service) and expose metrics in Prometheus format on port 9400.

export BEYLA_PROMETHEUS_PORT=9400
export BEYLA_OPEN_PORT=8080
sudo -E ./beyla

Now, you should see metrics on http://localhost:9400/metrics.

See Documentation and the tutorials for more info.

Requirements

• Linux with Kernel 5.8 or higher with BTF enabled, or Linux distributions running RedHat Enterprise Linux 4.18 kernels build 348 and above as they have the required kernel backports. These include CentOS, AlmaLinux, and Oracle Linux. BTF became enabled by default on most Linux distributions with kernel 5.14 or higher. You can check if your kernel has BTF enabled by verifying if /sys/kernel/btf/vmlinux exists on your system. If you need to recompile your kernel to enable BTF, the configuration option CONFIG_DEBUG_INFO_BTF=y must be set.
• eBPF enabled on the host.
• For instrumenting Go programs, they must have been compiled with at least Go 1.17. We currently support Go applications built with a major Go version no earlier than 3 versions behind the current stable major release.
• Some level of elevated permissions to execute the instrumenter:
  • On host systems, running Beyla requires sudo.
  • For Kubernetes we have detailed configuration example on how to run with minimum required capabilities in the examples/k8s/unprivileged.yaml file.
  • For docker compose, you need to setup Beyla as privileged container or grant the SYS_ADMIN capability.

The Go instrumentation is limited to certain specific libraries.

HTTPS instrumentation is limited to Go programs and libraries/languages using libssl3.

Kubernetes

You can just trigger the Kubernetes descriptors in the deployments/ folder.

1. Provide your Grafana credentials. Use the following K8s Secret template to introduce the endpoints, usernames and API keys for Mimir and Tempo:

   $ cp deployments/01-grafana-credentials.template.yml 01-grafana-credentials.yml
   $ # EDIT the fields
   $ vim 01-grafana-credentials.yml
   $ kubectl apply -f 01-grafana-credentials.yml 
   

2. Deploy the Grafana Agent:

   kubectl apply -f deployments/02-grafana-agent.yml
   

3. Deploy a demo app with the auto-instrumenter as a sidecar. You can use the blog example in the deployments/03-instrumented-app.yml file.

   $ kubectl apply -f ./deployments/03-instrumented-app.yml
   $ kubectl port-forward service/goblog 8443:8443
   

You should be able to query traces and metrics in your Grafana board.

Building Beyla from scratch

Development environment requirements

Minimum requirements

• go 1.25
• docker
• GNU make

Optional requirements

• llvm >= 19
• clang >= 19

Common Makefile targets

Beyla's Makefile provides several specific-purpose build targets. The most common ones are:

• prereqs - install the build pre-requisites
• docker-generate - regenerates the eBPF binaries (preferred method)
• generate - regenerates the eBPF binaries [^1]
• compile - compiles the beyla binary (but does not automatically regenerates the eBPF binaries)
• dev - equivalent to make prereqs && make docker-generate && make compile
• test - runs unit tests
• integration-test - runs integration tests - may require sudo
• clang-format - formats C (eBPF) source code[^1]
• vendor-obi - Downloads all the Opentelemetry-eBPF-Instrumentation (OBI) dependencies in a submodule, builds the BPF targets, and vendors it.

[^1]: Requires llvm/clang

Quickstart

$ git clone https://github.com/grafana/beyla.git
$ cd beyla/
$ make dev

As described in the previous section, make dev takes care of setting up the build pre-requisites, including deploying a clang-format pre-commit hook.

After a successful compilation, binaries can be found in the bin/ subdirectory.

Managing code dependencies to opentelemetry-ebpf-instrumentation

Beyla vendors part of the code from the opentelemetry-ebpf-instrumentation (OBI) project.

The code is incorporated as a Git submodule, named obi-src, in the .obi-src folder in the Beyla code base. The contents of the .obi-src are used to build the BPF dependencies, and in a second step they are vendored in the vendor/ directory.

Usually, you just need to run make vendor-obi to get the submodule data, compile BPF targets, and vendor them locally.

.obi-src folder is pinned to a concrete version of the OBI Git history. If you did changes in the upstream opentelemetry-ebpf-instrumentation repository, and want to update .obi-src to the latest contents, you'll need to run, from Beyla's project folder:

git submodule update --checkout --remote 
git add .

(git add . is really important, otherwise when you try to recompile the code, the obi-src submodule might be reverted to its original status).

Developing with a local, development branch of opentelemetry-ebpf-instrumentation

Temporarily go to go.mod and change the first replace directive by your local OBI folder. For example:

-replace go.opentelemetry.io/obi => ./.obi-src
+replace go.opentelemetry.io/obi => ../opentelemetry-ebpf-instrumentation

Build the docker image with make dev-image-build.

⚠️ Before pushing your changes to our GitHub repo, don't forget to revert the replace directive in go.mod!

Formatting and linting code

Beyla uses linters to enforce our coding style and best practices:

• golangci-lint for Go code
• clang-format for formatting C code
• clang-tidy for static analysis of the C code

All of them are enforced on pull requests as part of the Beyla github workflows. Additionally, you can invoke the linters manually:

• make lint invokes golangci-lint on the Go code
• make clang-tidy invokes clang-tidy on the C/eBPF code

clang-format is invoked automatically as a pre-commit git hook, you can run it directly by using the Makefile clang-format target.

Running VM tests

In addition to the test and integration-test Makefile targets, Beyla also runs select tests on QEMU virtual machines in order to be able to test different kernel versions. These tests are also part of our GitHub workflow, but it is also possible to run them manually using the following command:

$ sudo make -C internal/testgenerated/vm KERNEL_VER=...

where KERNEL_VER is one of the supported kernel versions located in internal/testgenerated/vm/kernels. For example, to run tests against kernel version 5.15.152, simply do:

$ sudo make -C internal/testgenerated/vm KERNEL_VER=5.15.152

Credits

Part of the code is taken from: https://github.com/open-telemetry/opentelemetry-go-instrumentation