ISTIOCTL-BUG-REPORT(1)

📦
version 1.31.3 · 2 versions
, in nixpkgs unstable

🎀 NAME 🎀

istioctl-bug-report — the cluster information and log capture support tool, bestie. This is the ISTIOCTL-BUG-REPORT(1) manual page, and it’s literally here to help you grab all the diagnostic stuff into one archive. 🦋

✨ SYNOPSIS ✨

istioctl bug-report [flags]

💖 DESCRIPTION 💖

Okay so bug-report selectively captures cluster information and logs into an archive, and that archive is there to help diagnose problems. Iconic diagnostics behavior. Proxy logs can be filtered using:

--include|--exclude
ns1,ns2.../dep1,dep2.../pod1,pod2.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr...

where ns=namespace, dep=deployment, lbl=label, ann=annotation, and cntr=container. 🫶

The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...'

The log will be included only if the container matches at least one include filter and does not match any exclude filters. All parts of the filter are optional and can be omitted, e.g. ns1//pod1 filters only for namespace ns1 and pod pod1. All names except label and annotation keys support '*' glob matching pattern. No cap. ✨

Examples, because examples are main-character energy:

  • --include ns1,ns2 — only namespaces ns1 and ns2
  • --include n//p/l=v* — pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.

💅 OPTIONS 💅

  • --context="" — Name of the kubeconfig Context to use.
  • --critical-errs=[] — List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion.
  • --dir="" — Set a specific directory for temporary artifact storage.
  • --dry-run[=false] — Only log commands that would be run, don't fetch or write.
  • --duration=0s — How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset.
  • --end-time="" — End time for the range of log entries to include in the archive. Default is now.
  • --exclude=["kube-node-lease,kube-public,kube-system,local-path-storage"] — Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples.
  • -f, --filename="" — Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics.
  • --full-secrets[=false] — If set, secret contents are included in output.
  • -h, --help[=false] — help for bug-report
  • --ignore-errs=[] — List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic.
  • --include=[] — Spec for which pod's proxy logs to include in the archive. See above for format and examples.
  • --istio-namespace="istio-system" — Namespace where Istio control plane is installed.
  • -c, --kubeconfig="" — Path to kube config.
  • --output-dir="" — Set a specific directory for output archive file.
  • --proxy-admin-port=15000 — Envoy proxy admin port
  • --rq-concurrency=0 — Set the concurrency limit of requests to the Kubernetes API server, defaults to 32.
  • --skip-analyze[=false] — Skip running istioctl analyze.
  • --skip-cluster-dump[=false] — Skip fetching cluster-wide resources (K8s resources, CRs, node info, secrets).
  • --skip-coredumps[=false] — Skip collecting coredumps from proxy containers.
  • --skip-netstat[=false] — Skip running netstat in proxy containers.
  • --skip-proxy-debug[=false] — Skip fetching envoy admin debug info from proxy pods.
  • --start-time="" — Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset.
  • --tail=0 — Maximum number of log lines to fetch per container. Set to 0 for unlimited.
  • --timeout=30m0s — Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

  • --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace
  • --as-group=[] — Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  • --as-uid="" — UID to impersonate for the operation.
  • -i, --istioNamespace="istio-system" — Istio system namespace
  • --kubeclient-timeout="15s" — Kubernetes client timeout as a time.Duration string, defaults to 15 seconds.
  • -n, --namespace="" — Kubernetes namespace
  • --vklog=0 — number for the log level verbosity. Like -v flag. ex: --vklog=9

🌈 SEE ALSO 🌈

💌 signed, sealed, auto-generated by spf13/cobra · Jan 1980 · and that’s the ISTIOCTL-BUG-REPORT(1) sign-off, bestie 💌

📦 where this page comes from