Skip to content

Commit 4ddde5d

Browse files
authored
Add profiling no kernel version check docs(#3168)
1 parent 6a5abf3 commit 4ddde5d

File tree

3 files changed

+25
-1
lines changed

3 files changed

+25
-1
lines changed

docs/en/observability/index.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ include::profiling-tag-data-query.asciidoc[leveloffset=+3]
144144
include::profiling-add-symbols.asciidoc[leveloffset=+3]
145145
include::profiling-use-a-proxy.asciidoc[leveloffset=+3]
146146
include::profiling-probabilistic-profiling.asciidoc[leveloffset=+3]
147+
include::profiling-no-kernel-version-check.asciidoc[leveloffset=+3]
147148

148149
include::profiling-upgrade.asciidoc[leveloffset=+2]
149150

docs/en/observability/profiling-advanced-configuration.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ See the following sections for more information:
77
* <<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.
88
* <<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.).
99
* <<profiling-use-a-proxy,Use a proxy>>: Set up an HTTP proxy if your infrastructure host-agent installation needs one to reach {ecloud}.
10-
* <<profiling-probabilistic-profiling, Configure probabilistic profiling>>: Configure Universal Profiling Agent to run in probabilistic profiling mode.
10+
* <<profiling-probabilistic-profiling, Configure probabilistic profiling>>: Configure the Universal Profiling agent to run in probabilistic profiling mode.
11+
12+
* <<profiling-no-kernel-version-check, Override kernel version check >>: Configure the Universal Profiling agent to bypass the kernel version compatibility check.
13+
14+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[[profiling-no-kernel-version-check]]
2+
= Override kernel version check
3+
4+
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.
5+
6+
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.
7+
8+
[discrete]
9+
[[profiling-no-kernel-example]]
10+
== Host agent configuration example
11+
12+
The following example shows how to configure the `-no-kernel-version-check` in the Universal Profiling agent CLI:
13+
14+
[source,bash]
15+
----
16+
sudo pf-host-agent/pf-host-agent -no-kernel-version-check=true ...'
17+
----
18+
19+

0 commit comments

Comments
 (0)