Skip to content

diagnose.md

Latest commit

 

History

History
58 lines (40 loc) · 2.08 KB

diagnose.md

File metadata and controls

58 lines (40 loc) · 2.08 KB
Raw

Diagnose

fluid diagnose collects diagnostic artifacts for a Fluid Dataset: CR YAML, pod descriptions, logs, namespace events, PVC/PV data, and an optional tar.gz archive for support.

When to use diagnose

  • Opening a GitHub issue or vendor support ticket
  • Capturing cluster state after an incident
  • Sharing a timestamped bundle with your team

Use fluid inspect for a lightweight resource listing without log collection.

Basic usage

# Collect into a timestamped directory (default TUI to browse results)
fluid diagnose my-dataset -n default

# Write artifacts only (no TUI)
fluid diagnose my-dataset -n default -o dir

# Create a tar.gz archive for attachment
fluid diagnose my-dataset -n default --archive -o dir

Output layout

Artifacts are written under a directory such as fluid-diagnose-<dataset>-<timestamp>/:

Path Contents
dataset.yaml Dataset CR
dataset.describe.txt Human-readable Dataset summary
runtime/ Runtime CRs and descriptions
pods/ Per-pod YAML, describe, and logs
events/ Namespace events
storage/ PVC and PV YAML
controllers/ Fluid controller logs (if --include-controller-logs)
summary.txt High-level summary and warnings
manifest.json Index of every artifact and collection status

manifest.json records each file with status (collected, failed, skipped) and an optional reason. Partial failures are normal when pods are missing or logs are unavailable; check summary.txt and the manifest.

With --archive, a .tar.gz is produced alongside the directory (see command output for the path).

Support workflow

  1. Run diagnose with --archive and -o dir in non-interactive environments.
  2. Redact secrets from the bundle if needed before sharing.
  3. Attach the archive to your issue along with fluid version output.

Flags and help

fluid diagnose --help

Notable options include --output-dir, --no-logs, --include-controller-logs, and --since (limit log/event age). Defaults and full descriptions are in --help.