From 80fdc6347d3adde56a79f2db2917f10b6521cd7a Mon Sep 17 00:00:00 2001 From: Kornilios Kourtis Date: Fri, 27 Oct 2023 10:00:22 +0200 Subject: [PATCH] docs: sysdump and bugtool Add a troubleshooting section with information about sysdump and bugtool. Signed-off-by: Kornilios Kourtis --- .../content/en/docs/troubleshooting/_index.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/content/en/docs/troubleshooting/_index.md diff --git a/docs/content/en/docs/troubleshooting/_index.md b/docs/content/en/docs/troubleshooting/_index.md new file mode 100644 index 00000000000..a08eeb34e63 --- /dev/null +++ b/docs/content/en/docs/troubleshooting/_index.md @@ -0,0 +1,31 @@ +--- +title: "Troubleshooting" +weight: 8 +icon: "faq" +description: Troubleshooting Tetragon +--- + +## Reporting a problem + +Before you report a problem, make sure to retrieve the necessary information from your cluster. + +### Automatic log & state collection + +You collect information in a Kubernetes cluster using the Cilium CLI: + +```shell-session +cilium-cli sysdump +``` + +More details can be found in the [Cilium docs](https://docs.cilium.io/en/stable/operations/troubleshooting/#automatic-log-state-collection). + +### Single Node Bugtool + +If you are not running Kubernetes, it is also possible to run the bug collection tool manually with the scope of a single node using: + +```shell-session +tetra bugtool +``` + +Tetragon's bugtool captures potentially useful information about your environment for debugging. The tool is meant to be used for debugging a single Tetragon agent node. Note in Kubernetes, the command needs to be run from inside the Tetragon pod/container. +