Skip to content

Commit

Permalink
docs: sysdump and bugtool
Browse files Browse the repository at this point in the history
Add a troubleshooting section with information about sysdump and
bugtool.

Signed-off-by: Kornilios Kourtis <[email protected]>
  • Loading branch information
kkourt committed Nov 1, 2023
1 parent 752ce86 commit 80fdc63
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/content/en/docs/troubleshooting/_index.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 80fdc63

Please sign in to comment.