Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaelroquetto committed Sep 18, 2024
1 parent 9feffcc commit e49dec2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,12 @@ See [Documentation](https://grafana.com/docs/beyla/) and the [tutorials](https:/
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 on the host
set.
- Alternatively, RHEL 4.18 Linux kernels (at least build 348) are also supported, due to their heavily backported nature.
- 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.
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
Expand Down
1 change: 1 addition & 0 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Beyla offers the following features:
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.
- Alternatively, RHEL 4.18 Linux kernels (at least build 348) are also supported, due to their heavily backported nature.
- 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
Expand Down

0 comments on commit e49dec2

Please sign in to comment.