github.com/imran-kn/cilium-fork@v1.6.9/Documentation/cmdref/cilium-bugtool.md (about)

     1  <!-- This file was autogenerated via cilium cmdref, do not edit manually-->
     2  
     3  ## cilium-bugtool
     4  
     5  Collects agent & system information useful for bug reporting
     6  
     7  ### Synopsis
     8  
     9  Collects agent & system information useful for bug reporting
    10  
    11  ```
    12  cilium-bugtool [OPTIONS] [flags]
    13  ```
    14  
    15  ### Examples
    16  
    17  ```
    18  	# Collect information and create archive file
    19  	$ cilium-bugtool
    20  	[...]
    21  
    22  	# Collect and retrieve archive if Cilium is running in a Kubernetes pod
    23  	$ kubectl get pods --namespace kube-system
    24  	NAME                          READY     STATUS    RESTARTS   AGE
    25  	cilium-kg8lv                  1/1       Running   0          13m
    26  	[...]
    27  	$ kubectl -n kube-system exec cilium-kg8lv cilium-bugtool
    28  	$ kubectl cp kube-system/cilium-kg8lv:/tmp/cilium-bugtool-243785589.tar /tmp/cilium-bugtool-243785589.tar
    29  ```
    30  
    31  ### Options
    32  
    33  ```
    34        --archive                   Create archive when false skips deletion of the output directory (default true)
    35        --archive-prefix string     String to prefix to name of archive if created (e.g., with cilium pod-name)
    36    -o, --archiveType string        Archive type: tar | gz (default "tar")
    37        --config string             Configuration to decide what should be run (default "./.cilium-bugtool.config")
    38        --dry-run                   Create configuration file of all commands that would have been executed
    39        --enable-markdown           Dump output of commands in markdown format
    40        --exec-timeout duration     The default timeout for any cmd execution in seconds (default 30s)
    41        --get-pprof                 When set, only gets the pprof traces from the cilium-agent binary
    42    -h, --help                      help for cilium-bugtool
    43    -H, --host string               URI to server-side API
    44        --k8s-label string          Kubernetes label for Cilium pod (default "k8s-app=cilium")
    45        --k8s-mode                  Require Kubernetes pods to be found or fail
    46        --k8s-namespace string      Kubernetes namespace for Cilium pod (default "kube-system")
    47        --pprof-port int            Port on which pprof server is exposed (default 6060)
    48        --pprof-trace-seconds int   Amount of seconds used for pprof CPU traces (default 180)
    49    -t, --tmp string                Path to store extracted files (default "/tmp")
    50  ```
    51