clinic: fix config.json described as a directory instead of a file - #23836
clinic: fix config.json described as a directory instead of a file#23836yahonda wants to merge 1 commit into
Conversation
config.json has a .json extension and is documented elsewhere (clinic-data-instruction-for-tiup.md) as the per-component "Real-time configuration" file, not a directory.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe clinic user guide now states that configuration data is stored in each node's ChangesClinic user guide
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Merge Risk: ⚪ Minimal · up to The guide now correctly identifies config.json as a per-node configuration file, with no runtime impact. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What is changed, added or deleted? (Required)
"Configuration data: in the `config.json` directory of each node" incorrectly calls `config.json` a directory. `clinic-data-instruction-for-tiup.md` in this same repo documents `config.json` as the per-component "Real-time configuration" file (e.g. for TiDB, TiKV, PD, TiFlash), consistent with its `.json` extension.
Source-code verification: in the `pingcap/diag` (Clinic/tiup diag) source, `collector/config.go` builds a `configs` list of `rtConfig{"config.json", ...}` entries per component, then downloads each one to `filepath.Join(resultDir, host, instDir, "conf", config.filename)` — i.e. `config.json` is written out as a literal file at `.../conf/config.json` under each node's own subdirectory, confirming it is a file, not a directory.
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?