From 1671800487b203faccbd93618beb690cc7f13f1c Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Thu, 31 Aug 2023 11:19:17 -0500 Subject: [PATCH] Add profiling no kernel version check docs(#3168) (#3197) (cherry picked from commit 4ddde5d0ed6f3b485fa2adbdac300d6081adf93e) Co-authored-by: Israel Ogbole --- docs/en/observability/index.asciidoc | 1 + .../profiling-advanced-configuration.asciidoc | 6 +++++- ...profiling-no-kernel-version-check.asciidoc | 19 +++++++++++++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 docs/en/observability/profiling-no-kernel-version-check.asciidoc diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index a0872079cc..b6f9d3b7e7 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -142,6 +142,7 @@ include::profiling-tag-data-query.asciidoc[leveloffset=+3] include::profiling-add-symbols.asciidoc[leveloffset=+3] include::profiling-use-a-proxy.asciidoc[leveloffset=+3] include::profiling-probabilistic-profiling.asciidoc[leveloffset=+3] +include::profiling-no-kernel-version-check.asciidoc[leveloffset=+3] include::profiling-upgrade.asciidoc[leveloffset=+2] diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index 1d4a72725d..b6ceee5f3f 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -9,4 +9,8 @@ See the following sections for more information: * <>: Tag data collected by the host-agent into multiple logical groups so they can be queried in Kibana. * <>: Push symbols to your cluster so you can see function names and line numbers in traces of applications written in programming languages that compile to native code (C, C++, Rust, Go, etc.). * <>: Set up an HTTP proxy if your infrastructure host-agent installation needs one to reach {ecloud}. -* <>: Configure Universal Profiling Agent to run in probabilistic profiling mode. +* <>: Configure the Universal Profiling agent to run in probabilistic profiling mode. + +* <>: Configure the Universal Profiling agent to bypass the kernel version compatibility check. + + diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc new file mode 100644 index 0000000000..7c57df731a --- /dev/null +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -0,0 +1,19 @@ +[[profiling-no-kernel-version-check]] += Override kernel version check + +The `-no-kernel-version-check` flag, or the `no-kernel-version-check` key in the host-agent configuration file, controls the kernel version compatibility check during the profiling host-agent's startup process. The kernel version compatibility check enforces the minimum kernel version supported, and prevents the profiling agent from running on certain kernel versions with known issues. When the `no-kernel-version-check` is set to `true`, the compatibility check is bypassed, allowing host-agent execution to proceed regardless of the kernel version. By default, this option is set to `false`, and the kernel compatibility version check is performed as usual. + +WARNING: Take extra caution when using this configuration option, especially when running the host-agent on older kernels with backported eBPF functionalities. Setting this option to `true` on kernels with unfixed eBPF bugs can crash your system. + +[discrete] +[[profiling-no-kernel-example]] +== Host agent configuration example + +The following example shows how to configure the `-no-kernel-version-check` in the Universal Profiling agent CLI: + +[source,bash] +---- +sudo pf-host-agent/pf-host-agent -no-kernel-version-check=true ...' +---- + +