docs: document log directory size retention - #2838
Conversation
Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>
Deploying greptime-docs with
|
| Latest commit: |
6d66373
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f073f4fd.greptime-docs.pages.dev |
| Branch Preview URL: | https://copilot-update-docs-telemetr.greptime-docs.pages.dev |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🟢 Approval recommended
The documentation update is scoped, consistent across English/Chinese Nightly pages, and matches the described logging.max_log_dir_size behavior.
Pull request overview
Documents the new logging.max_log_dir_size configuration option (log directory size retention) in the Nightly configuration reference, keeping English and Chinese pages aligned.
Changes:
- Added
max_log_dir_size = "0B"to the[logging]TOML example snippet. - Added a description of
max_log_dir_size, including behavior around deleting closed log files and the “soft limit” note for active files.
File summaries
| File | Description |
|---|---|
| docs/user-guide/deployments-administration/configuration.md | Adds the new logging option to the English Nightly configuration example and option list. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md | Adds the same logging option and explanation to the Chinese Nightly configuration page. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
What changed
Documented the new
logging.max_log_dir_sizeoption introduced by the telemetry logging retention feature. The option defaults to0B; when configured, closed log files are removed before writes as needed while active files may exceed the limit.Scope
Verification
Checklist