From 35ab9cf001e9df27b09b0d6d7f4636e17163e437 Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 21 Jan 2022 16:05:49 -0600 Subject: [PATCH 1/5] add ebpf-required config --- admin/workspace-management/process-logging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/workspace-management/process-logging.md b/admin/workspace-management/process-logging.md index b6b6fcd01..0b111052e 100644 --- a/admin/workspace-management/process-logging.md +++ b/admin/workspace-management/process-logging.md @@ -30,7 +30,7 @@ The core of this feature is also open source and can be found in the ## Requirements Use of the workspace process logging functionality requires a host Linux -kernel >= 5.8. +kernel >= 5.8 with the environment variable `CONFIG_DEBUG_INFO_BTF=y` set. ## Enable workspace process logging From cbf0bcf33940a7a71215551ed25ef387f7b136d9 Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 21 Jan 2022 16:13:47 -0600 Subject: [PATCH 2/5] feat: add commands to check for kernel config --- admin/workspace-management/process-logging.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/admin/workspace-management/process-logging.md b/admin/workspace-management/process-logging.md index 0b111052e..33cad5c5a 100644 --- a/admin/workspace-management/process-logging.md +++ b/admin/workspace-management/process-logging.md @@ -30,7 +30,18 @@ The core of this feature is also open source and can be found in the ## Requirements Use of the workspace process logging functionality requires a host Linux -kernel >= 5.8 with the environment variable `CONFIG_DEBUG_INFO_BTF=y` set. +kernel >= 5.8 with the kernel config `CONFIG_DEBUG_INFO_BTF=y` enabled. + +To validate this config is enabled, run either of the following commands on the +machine in question: + +```console +cat /proc/config.gz | gunzip | grep CONFIG_DEBUG_INFO_BTF +``` + +``` +cat "/boot/config-$(uname -r)" | grep CONFIG_DEBUG_INFO_BTF +``` ## Enable workspace process logging From 025389f55c7b4b6e1aff67ceaa59a3da53afd909 Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 21 Jan 2022 16:15:14 -0600 Subject: [PATCH 3/5] fix: lint --- admin/workspace-management/process-logging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/workspace-management/process-logging.md b/admin/workspace-management/process-logging.md index 33cad5c5a..5880a52d4 100644 --- a/admin/workspace-management/process-logging.md +++ b/admin/workspace-management/process-logging.md @@ -39,7 +39,7 @@ machine in question: cat /proc/config.gz | gunzip | grep CONFIG_DEBUG_INFO_BTF ``` -``` +```console cat "/boot/config-$(uname -r)" | grep CONFIG_DEBUG_INFO_BTF ``` From 275a3f11b5e61ef3e7acfab252be6cdda00c35fe Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 21 Jan 2022 16:52:26 -0600 Subject: [PATCH 4/5] chore: wording Co-authored-by: Dean Sheather --- admin/workspace-management/process-logging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/workspace-management/process-logging.md b/admin/workspace-management/process-logging.md index 5880a52d4..6a0588057 100644 --- a/admin/workspace-management/process-logging.md +++ b/admin/workspace-management/process-logging.md @@ -33,7 +33,7 @@ Use of the workspace process logging functionality requires a host Linux kernel >= 5.8 with the kernel config `CONFIG_DEBUG_INFO_BTF=y` enabled. To validate this config is enabled, run either of the following commands on the -machine in question: +nodes directly (not from within a workspace): ```console cat /proc/config.gz | gunzip | grep CONFIG_DEBUG_INFO_BTF From a4a8b774f26da0f1ceca1b260f4a38953f3baa09 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 24 Jan 2022 11:04:38 -0600 Subject: [PATCH 5/5] Update process-logging.md --- admin/workspace-management/process-logging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/workspace-management/process-logging.md b/admin/workspace-management/process-logging.md index 6a0588057..bb5d628ea 100644 --- a/admin/workspace-management/process-logging.md +++ b/admin/workspace-management/process-logging.md @@ -33,7 +33,7 @@ Use of the workspace process logging functionality requires a host Linux kernel >= 5.8 with the kernel config `CONFIG_DEBUG_INFO_BTF=y` enabled. To validate this config is enabled, run either of the following commands on the -nodes directly (not from within a workspace): +nodes directly (*not* from the terminal within a workspace): ```console cat /proc/config.gz | gunzip | grep CONFIG_DEBUG_INFO_BTF