github.com/cilium/cilium@v1.16.2/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  ```
     8  cilium-bugtool [OPTIONS] [flags]
     9  ```
    10  
    11  ### Examples
    12  
    13  ```
    14  	# Collect information and create archive file
    15  	$ cilium-bugtool
    16  	[...]
    17  
    18  	# Collect and retrieve archive if Cilium is running in a Kubernetes pod
    19  	$ kubectl get pods --namespace kube-system
    20  	NAME                          READY     STATUS    RESTARTS   AGE
    21  	cilium-kg8lv                  1/1       Running   0          13m
    22  	[...]
    23  	$ kubectl -n kube-system exec cilium-kg8lv -- cilium-bugtool
    24  	$ kubectl cp kube-system/cilium-kg8lv:/tmp/cilium-bugtool-243785589.tar /tmp/cilium-bugtool-243785589.tar
    25  ```
    26  
    27  ### Options
    28  
    29  ```
    30        --archive                              Create archive when false skips deletion of the output directory (default true)
    31        --archive-prefix string                String to prefix to name of archive if created (e.g., with cilium pod-name)
    32    -o, --archiveType string                   Archive type: tar | gz (default "tar")
    33        --cilium-agent-container-name string   Name of the Cilium Agent main container (when k8s-mode is true) (default "cilium-agent")
    34        --config string                        Configuration to decide what should be run (default "./.cilium-bugtool.config")
    35        --dry-run                              Create configuration file of all commands that would have been executed
    36        --enable-markdown                      Dump output of commands in markdown format
    37        --envoy-dump                           When set, dump envoy configuration from unix socket (default true)
    38        --envoy-metrics                        When set, dump envoy prometheus metrics from unix socket (default true)
    39        --exclude-object-files                 Exclude per-endpoint object files. Template object files will be kept
    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        --hubble-metrics                       When set, hubble prometheus metrics (default true)
    45        --hubble-metrics-port int              Port to query for hubble metrics (default 9965)
    46        --k8s-label string                     Kubernetes label for Cilium pod (default "k8s-app=cilium")
    47        --k8s-mode                             Require Kubernetes pods to be found or fail
    48        --k8s-namespace string                 Kubernetes namespace for Cilium pod (default "kube-system")
    49        --parallel-workers int                 Maximum number of parallel worker tasks, use 0 for number of CPUs
    50        --pprof-debug int                      Debug pprof args (default 1)
    51        --pprof-port int                       Pprof port to connect to. Known Cilium component ports are agent:6060, operator:6061, apiserver:6063 (default 6060)
    52        --pprof-trace-seconds int              Amount of seconds used for pprof CPU traces (default 180)
    53    -t, --tmp string                           Path to store extracted files. Use '-' to send to stdout. (default "/tmp")
    54  ```
    55  
    56  ### SEE ALSO
    57  
    58  * [cilium-bugtool completion](cilium-bugtool_completion.md)	 - Generate the autocompletion script for the specified shell
    59