Skip to content

Commit

Permalink
Add profiling no kernel version check docs(#3168) (#3197)
Browse files Browse the repository at this point in the history
(cherry picked from commit 4ddde5d)

Co-authored-by: Israel Ogbole <[email protected]>
  • Loading branch information
mergify[bot] and iogbole authored Aug 31, 2023
1 parent bd59006 commit 1671800
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,8 @@ See the following sections for more information:
* <<profiling-tag-data-query, Tag data for querying>>: Tag data collected by the host-agent into multiple logical groups so they can be queried in Kibana.
* <<profiling-add-symbols, Add symbols for native frames>>: 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.).
* <<profiling-use-a-proxy,Use a proxy>>: Set up an HTTP proxy if your infrastructure host-agent installation needs one to reach {ecloud}.
* <<profiling-probabilistic-profiling, Configure probabilistic profiling>>: Configure Universal Profiling Agent to run in probabilistic profiling mode.
* <<profiling-probabilistic-profiling, Configure probabilistic profiling>>: Configure the Universal Profiling agent to run in probabilistic profiling mode.

* <<profiling-no-kernel-version-check, Override kernel version check >>: Configure the Universal Profiling agent to bypass the kernel version compatibility check.


19 changes: 19 additions & 0 deletions docs/en/observability/profiling-no-kernel-version-check.asciidoc
Original file line number Diff line number Diff line change
@@ -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 ...'
----


0 comments on commit 1671800

Please sign in to comment.