From fe60e0ad057a01fc58a9223defc3f9ed4203d7ef Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Fri, 25 Aug 2023 20:21:05 +0100 Subject: [PATCH 01/11] Create profiling-no-kernel-version-check.asciidoc --- ...profiling-no-kernel-version-check.asciidoc | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/en/observability/profiling-no-kernel-version-check.asciidoc 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..d3e9e9fe42 --- /dev/null +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -0,0 +1,20 @@ +[[no-kernel-version-check]] += Override Kernel Version Check + +The configuration option `-no-kernel-version-check` allows for the bypassing of the kernel version check that occurs during the Profiling host agent's startup process. This option takes a boolean argument; setting it to true will enable the bypass, while false is the default value, keeping the kernel version check in place. + +By setting this option to true, users can disable the checking of kernel versions for eBPF support. Use this feature at your own risk, especially when running the agent on older kernels with backported eBPF functionalities. + +On kernels with unfixed eBPF bugs, this could crash your system. + +[discrete] +== Example + +The following example shows how to configure the Universal Profiling agent with a threshold of 50 and an interval of 2 minutes and 30 seconds: + +[source,bash] +---- +sudo pf-host-agent/pf-host-agent -no-kernel-version-check=true ...' +---- + + From 0a95b2ca8df77e6f39f1264915a2cf98660a19ab Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Fri, 25 Aug 2023 20:22:54 +0100 Subject: [PATCH 02/11] Update profiling-no-kernel-version-check.asciidoc --- .../profiling-no-kernel-version-check.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc index d3e9e9fe42..4a5ebef5d0 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,16 +1,16 @@ [[no-kernel-version-check]] = Override Kernel Version Check -The configuration option `-no-kernel-version-check` allows for the bypassing of the kernel version check that occurs during the Profiling host agent's startup process. This option takes a boolean argument; setting it to true will enable the bypass, while false is the default value, keeping the kernel version check in place. +The configuration option `-no-kernel-version-check` allows for the bypassing of the kernel version check that occurs during the Profiling host agent's startup process. This option takes a boolean argument; setting it to `true` will enable the bypass, while `false` is the default value, keeping the kernel version check in place. -By setting this option to true, users can disable the checking of kernel versions for eBPF support. Use this feature at your own risk, especially when running the agent on older kernels with backported eBPF functionalities. +By setting this option to `true`, users can disable the checking of kernel versions for eBPF support. Use this feature at your own risk, especially when running the agent on older kernels with backported eBPF functionalities. On kernels with unfixed eBPF bugs, this could crash your system. [discrete] == Example -The following example shows how to configure the Universal Profiling agent with a threshold of 50 and an interval of 2 minutes and 30 seconds: +The following example shows how to configure the `-no-kernel-version-check` in the Universal Profiling agent CLI [source,bash] ---- From 1d41434da7fa9b13acaa34fb654ff825126684dc Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Fri, 25 Aug 2023 20:36:52 +0100 Subject: [PATCH 03/11] Update profiling-no-kernel-version-check.asciidoc --- .../observability/profiling-no-kernel-version-check.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc index 4a5ebef5d0..43f670a6f4 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,9 +1,9 @@ [[no-kernel-version-check]] = Override Kernel Version Check -The configuration option `-no-kernel-version-check` allows for the bypassing of the kernel version check that occurs during the Profiling host agent's startup process. This option takes a boolean argument; setting it to `true` will enable the bypass, while `false` is the default value, keeping the kernel version check in place. +The `-no-kernel-version-check` configuration option is used to control the kernel version compatibility check during the Profiling host agent's startup process. The kernel version check is used to enforce the minimum kernel version supported, currently version 4.15, and to prevent running the profiling agent on certain kernel versions with known issues. When this option is set to `true`, the compatibility check is bypassed, allowing the process to proceed regardless of the kernel version. The default value for this option is `false`, which means that the kernel version check is performed as usual. -By setting this option to `true`, users can disable the checking of kernel versions for eBPF support. Use this feature at your own risk, especially when running the agent on older kernels with backported eBPF functionalities. +Use this configuration option with utmost care, especially when running the agent on older kernels with backported eBPF functionalities. On kernels with unfixed eBPF bugs, this could crash your system. From fcb05203e5397530f66a1fe8d89222b918106463 Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Fri, 25 Aug 2023 20:37:37 +0100 Subject: [PATCH 04/11] Update profiling-advanced-configuration.asciidoc --- docs/en/observability/profiling-advanced-configuration.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index 93f8d9820c..c6e63d6d61 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -8,3 +8,4 @@ See the following sections for more information: * <>: 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 Universal Profiling Agent to bypass the kernel version compatibility check. From 858296b6f136440e3d246166d1fbd77aa89e7424 Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Fri, 25 Aug 2023 20:38:21 +0100 Subject: [PATCH 05/11] Update profiling-advanced-configuration.asciidoc --- docs/en/observability/profiling-advanced-configuration.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index c6e63d6d61..de5633ca21 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -8,4 +8,4 @@ See the following sections for more information: * <>: 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 Universal Profiling Agent to bypass the kernel version compatibility check. +* <>: Configure Universal Profiling Agent to bypass the kernel version compatibility check. From aae8700d39d82408ce36d779c317b138f58ed2ac Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Mon, 28 Aug 2023 14:30:36 +0100 Subject: [PATCH 06/11] Update docs/en/observability/profiling-no-kernel-version-check.asciidoc Co-authored-by: Christos Kalkanis --- .../en/observability/profiling-no-kernel-version-check.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc index 43f670a6f4..c176fb2271 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,7 +1,7 @@ [[no-kernel-version-check]] = Override Kernel Version Check -The `-no-kernel-version-check` configuration option is used to control the kernel version compatibility check during the Profiling host agent's startup process. The kernel version check is used to enforce the minimum kernel version supported, currently version 4.15, and to prevent running the profiling agent on certain kernel versions with known issues. When this option is set to `true`, the compatibility check is bypassed, allowing the process to proceed regardless of the kernel version. The default value for this option is `false`, which means that the kernel version check is performed as usual. +The `-no-kernel-version-check` flag, or the `no-kernel-version-check` key in the host-agent configuration file, is used to control the kernel version compatibility check during the Profiling host agent's startup process. The kernel version check is used to enforce the minimum kernel version supported, currently version 4.15, and to prevent running the profiling agent on certain kernel versions with known issues. When this option is set to `true`, the compatibility check is bypassed, allowing host agent execution to proceed regardless of the kernel version. The default value for this option is `false`, which means that the kernel version check is performed as usual. Use this configuration option with utmost care, especially when running the agent on older kernels with backported eBPF functionalities. From 22e539d5ad73cab3ebe2fba1aaef72133c13b481 Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Mon, 28 Aug 2023 14:30:48 +0100 Subject: [PATCH 07/11] Update docs/en/observability/profiling-advanced-configuration.asciidoc Co-authored-by: Christos Kalkanis --- .../en/observability/profiling-advanced-configuration.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index de5633ca21..02efc11d4c 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -8,4 +8,5 @@ See the following sections for more information: * <>: 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 Universal Profiling Agent to bypass the kernel version compatibility check. +* <>: Configure Universal Profiling agent to bypass the kernel version compatibility check. + From ecd1f91d9b3ba044adaa8ebd36b1422e5103bcab Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Mon, 28 Aug 2023 14:30:57 +0100 Subject: [PATCH 08/11] Update docs/en/observability/profiling-no-kernel-version-check.asciidoc Co-authored-by: Christos Kalkanis --- .../en/observability/profiling-no-kernel-version-check.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc index c176fb2271..86e1274f4f 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,4 +1,4 @@ -[[no-kernel-version-check]] +[[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, is used to control the kernel version compatibility check during the Profiling host agent's startup process. The kernel version check is used to enforce the minimum kernel version supported, currently version 4.15, and to prevent running the profiling agent on certain kernel versions with known issues. When this option is set to `true`, the compatibility check is bypassed, allowing host agent execution to proceed regardless of the kernel version. The default value for this option is `false`, which means that the kernel version check is performed as usual. From 9c366b04f39dc4271e80741e86ef11a00c39965d Mon Sep 17 00:00:00 2001 From: mdbirnstiehl Date: Mon, 28 Aug 2023 19:43:03 -0500 Subject: [PATCH 09/11] add override kernel check to index --- docs/en/observability/index.asciidoc | 1 + .../profiling-no-kernel-version-check.asciidoc | 13 ++++++------- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/observability/index.asciidoc b/docs/en/observability/index.asciidoc index c5f9848e12..d487fb1eb4 100644 --- a/docs/en/observability/index.asciidoc +++ b/docs/en/observability/index.asciidoc @@ -144,6 +144,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-no-kernel-version-check.asciidoc b/docs/en/observability/profiling-no-kernel-version-check.asciidoc index 86e1274f4f..77afbcd98e 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,16 +1,15 @@ [[profiling-no-kernel-version-check]] -= Override 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, is used to control the kernel version compatibility check during the Profiling host agent's startup process. The kernel version check is used to enforce the minimum kernel version supported, currently version 4.15, and to prevent running the profiling agent on certain kernel versions with known issues. When this option is set to `true`, the compatibility check is bypassed, allowing host agent execution to proceed regardless of the kernel version. The default value for this option is `false`, which means that the kernel version check is performed as usual. +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, currently version 4.15, 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. -Use this configuration option with utmost care, especially when running the agent on older kernels with backported eBPF functionalities. - -On kernels with unfixed eBPF bugs, this could crash your system. +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] -== Example +[[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 +The following example shows how to configure the `-no-kernel-version-check` in the Universal Profiling agent CLI: [source,bash] ---- From 57ffb674aedff0a744468da758022d3df2668317 Mon Sep 17 00:00:00 2001 From: Israel Ogbole Date: Thu, 31 Aug 2023 15:26:13 +0100 Subject: [PATCH 10/11] Update docs/en/observability/profiling-advanced-configuration.asciidoc Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../en/observability/profiling-advanced-configuration.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index 02efc11d4c..c40ae375c5 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -8,5 +8,6 @@ See the following sections for more information: * <>: 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 Universal Profiling agent to bypass the kernel version compatibility check. +* <>: Configure the Universal Profiling agent to bypass the kernel version compatibility check. + From 9255b93099ca3c0a657c8efb98ebaaf93fba6236 Mon Sep 17 00:00:00 2001 From: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> Date: Thu, 31 Aug 2023 09:28:57 -0500 Subject: [PATCH 11/11] Apply suggestions from code review --- .../en/observability/profiling-advanced-configuration.asciidoc | 3 ++- .../observability/profiling-no-kernel-version-check.asciidoc | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/profiling-advanced-configuration.asciidoc b/docs/en/observability/profiling-advanced-configuration.asciidoc index c40ae375c5..8b7e4ec1c0 100644 --- a/docs/en/observability/profiling-advanced-configuration.asciidoc +++ b/docs/en/observability/profiling-advanced-configuration.asciidoc @@ -7,7 +7,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 index 77afbcd98e..7c57df731a 100644 --- a/docs/en/observability/profiling-no-kernel-version-check.asciidoc +++ b/docs/en/observability/profiling-no-kernel-version-check.asciidoc @@ -1,7 +1,7 @@ [[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, currently version 4.15, 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. +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.