Skip to content

Commit 5705ad9

Browse files
Merge pull request #97347 from openshift-cherrypick-robot/cherry-pick-96619-to-rhacs-docs-4.7
[rhacs-docs-4.7] Update Collector troubleshooting guide
2 parents ac17a78 + cbf2e19 commit 5705ad9

File tree

4 files changed

+45
-58
lines changed

4 files changed

+45
-58
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * troubleshooting/commonly-occurring-error-conditions.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="failing-to-load-the-ebpf-probe_{context}"]
7+
= Failing to load the eBPF probe
8+
9+
Before Collector starts, it loads the eBPF probe; however, in rare cases, you might encounter issues where Collector cannot load the eBPF probe, which results in various error messages or exceptions. In such cases, you must check the logs to identify the problems with failure in loading the eBPF probe.
10+
11+
Consider the following Collector log:
12+
13+
[source,terminal]
14+
----
15+
[...]
16+
[INFO 2025/07/24 10:26:37] Trying to open the right engine!
17+
[INFO 2025/07/24 10:26:41] libbpf: prog 'execve_x': -- BEGIN PROG LOAD LOG --
18+
[...]
19+
-- END PROG LOAD LOG --
20+
[INFO 2025/07/24 10:26:41] libbpf: prog 'execve_x': failed to load: -7
21+
[INFO 2025/07/24 10:26:41] libbpf: failed to load object 'bpf_probe'
22+
[INFO 2025/07/24 10:26:41] libbpf: failed to load BPF skeleton 'bpf_probe': -7
23+
[INFO 2025/07/24 10:26:41] libpman: failed to load BPF object (errno: 7 | message: Argument list too long)
24+
----
25+
26+
If you encounter this kind of error, you must report it to {product-title} ({product-title-short}) support team or create an issue in the `stackrox/collector` GitHub repository.

modules/failing-to-load-the-kernel-driver.adoc

Lines changed: 0 additions & 39 deletions
This file was deleted.

modules/unable-to-connect-to-the-sensor.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ When starting, first check if you can connect to Sensor. Sensor is responsible f
1212
Collector Version: 3.15.0
1313
OS: Ubuntu 20.04.4 LTS
1414
Kernel Version: 5.4.0-126-generic
15-
Starting StackRox Collector...
16-
[INFO 2023/05/13 12:20:43] Hostname: 'hostname'
1715
[...]
1816
[INFO 2023/05/13 12:20:43] Sensor configured at address: sensor.stackrox.svc:9998
1917
[INFO 2023/05/13 12:20:43] Attempting to connect to Sensor
@@ -23,7 +21,7 @@ Starting StackRox Collector...
2321
[INFO 2023/05/13 12:21:13] Kernel driver candidates:
2422
[INFO 2023/05/13 12:21:13] ====================================
2523
[INFO 2023/05/13 12:21:13]
26-
[FATAL 2023/05/13 12:21:13] Unable to connect to Sensor.
24+
[FATAL 2023/05/13 12:21:13] Unable to connect to Sensor at 'sensor.stackrox.svc:9998'.
2725
----
2826

2927
This error could mean that Sensor has not started correctly or that Collector configuration is incorrect. To fix this issue, you must verify Collector configuration to ensure that Sensor address is correct and that the Sensor pod is running correctly.

troubleshooting/commonly-occurring-error-conditions.adoc

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,36 @@ toc::[]
88

99

1010
[role="_abstract"]
11-
Most errors occur during Collector startup when Collector configures itself and finds or downloads a kernel driver for the system.
11+
Most errors occur during Collector startup when Collector configures itself and loads eBPF probe into the system.
1212

13-
The following diagram describes the main parts
14-
of Collector startup process:
13+
Collector startup process involves the following stages:
1514

16-
.Collector pod startup process
17-
image::acs-collector-startup-process.png[Collector pod startup process]
15+
* Parse Configuration
16+
* Analyze Host
17+
* Connecting to Sensor
18+
* Loading eBPF probe
1819
19-
If any part of the startup procedure fails, the logs display a diagnostic summary detailing which steps succeeded or failed .
20+
Failure at any step is considered fatal. If any part of the startup
21+
procedure fails, the logs display a diagnostic summary with details about which steps
22+
succeeded or failed.
2023

21-
The following log file example shows a successful startup:
24+
The following log file example shows a successful startup:
2225

2326
[source,terminal]
2427
----
25-
[INFO 2022/11/28 13:21:55] == Collector Startup Diagnostics: ==
26-
[INFO 2022/11/28 13:21:55] Connected to Sensor? true
27-
[INFO 2022/11/28 13:21:55] Kernel driver available? true
28-
[INFO 2022/11/28 13:21:55] Driver loaded into kernel? true
29-
[INFO 2022/11/28 13:21:55] ====================================
28+
[INFO 2025/07/24 10:05:54] == Collector Startup Diagnostics: ==
29+
[INFO 2025/07/24 10:05:54] Connected to Sensor? false
30+
[INFO 2025/07/24 10:05:54] Kernel driver candidates:
31+
[INFO 2025/07/24 10:05:54] core_bpf (available)
32+
[INFO 2025/07/24 10:05:54] Driver loaded into kernel: core_bpf
33+
[INFO 2025/07/24 10:05:54] ====================================
3034
----
3135

32-
The log output confirms that Collector connected to Sensor and located and loaded the kernel driver.
36+
The log output confirms that Collector connected to Sensor and loaded the eBPF probe.
3337
You can use this log to check for the successful startup of Collector.
3438

3539

3640
include::modules/unable-to-connect-to-the-sensor.adoc[leveloffset=+1]
3741

38-
include::modules/unavailability-of-the-kernel-driver.adoc[leveloffset=+1]
39-
40-
include::modules/failing-to-load-the-kernel-driver.adoc[leveloffset=+1]
42+
include::modules/failing-to-load-the-ebpf-probe.adoc[leveloffset=+1]
4143

0 commit comments

Comments
 (0)