Skip to content

Commit

Permalink
Update and document Beyla requirements (grafana#500)
Browse files Browse the repository at this point in the history
  • Loading branch information
mariomac committed Dec 11, 2023
1 parent 21bcc01 commit 9045633
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ See [Documentation](https://grafana.com/docs/beyla/v1.0.x/) and the [quickstart

## Requirements

- Linux with Kernel 4.18 or higher with [BTF](https://www.kernel.org/doc/html/latest/bpf/btf.html)
- Linux with Kernel 5.8 or higher with [BTF](https://www.kernel.org/doc/html/latest/bpf/btf.html)
enabled. 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
Expand Down
13 changes: 13 additions & 0 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ Beyla offers the following features:
- listen to the Kubernetes API to decorate metrics and traces with Pods and Services metadata
- simple setup for Grafana customers already using Grafana Agent

## Requirements

- Linux with Kernel 5.8 or higher with [BTF](https://www.kernel.org/doc/html/latest/bpf/btf.html)
enabled. 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 in 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.
- Administrative access rights to execute Beyla.

## Get started

Follow the [setup]({{< relref "./setup/_index.md" >}}) documentation to get started with Beyla either as a standalone
Expand Down

0 comments on commit 9045633

Please sign in to comment.